Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NetworkLoadBalancerClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • NetworkLoadBalancerClient

Constructors

constructor

  • new NetworkLoadBalancerClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): NetworkLoadBalancerClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "NetworkLoadBalancer"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://network-load-balancer-api.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

changeNetworkLoadBalancerCompartment

close

  • close(): void

createBackend

createBackendSet

createListener

createNetworkLoadBalancer

createWaiters

deleteBackend

  • Removes a backend server from a given network load balancer and backend set. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteBackend API.

    Parameters

    Returns Promise<DeleteBackendResponse>

    DeleteBackendResponse

deleteBackendSet

  • Deletes the specified backend set. Note that deleting a backend set removes its backend servers from the network load balancer.

    Before you can delete a backend set, you must remove it from any active listeners.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteBackendSet API.

    Parameters

    Returns Promise<DeleteBackendSetResponse>

    DeleteBackendSetResponse

deleteListener

deleteNetworkLoadBalancer

getBackend

  • Retrieves the configuration information for the specified backend server. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetBackend API.

    Parameters

    Returns Promise<GetBackendResponse>

    GetBackendResponse

getBackendHealth

  • Retrieves the current health status of the specified backend server. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetBackendHealth API.

    Parameters

    Returns Promise<GetBackendHealthResponse>

    GetBackendHealthResponse

getBackendSet

  • Retrieves the configuration information for the specified backend set. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetBackendSet API.

    Parameters

    Returns Promise<GetBackendSetResponse>

    GetBackendSetResponse

getBackendSetHealth

getHealthChecker

  • Retrieves the health check policy information for a given network load balancer and backend set. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetHealthChecker API.

    Parameters

    Returns Promise<GetHealthCheckerResponse>

    GetHealthCheckerResponse

getListener

  • Retrieves listener properties associated with a given network load balancer and listener name. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetListener API.

    Parameters

    Returns Promise<GetListenerResponse>

    GetListenerResponse

getNetworkLoadBalancer

getNetworkLoadBalancerHealth

getWaiters

getWorkRequest

  • Retrieves the details of the work request with the given identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

listBackendSets

  • Lists all backend sets associated with a given network load balancer. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListBackendSets API.

    Parameters

    Returns Promise<ListBackendSetsResponse>

    ListBackendSetsResponse

listBackends

  • Lists the backend servers for a given network load balancer and backend set. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListBackends API.

    Parameters

    Returns Promise<ListBackendsResponse>

    ListBackendsResponse

listListeners

  • Lists all listeners associated with a given network load balancer. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListListeners API.

    Parameters

    Returns Promise<ListListenersResponse>

    ListListenersResponse

listNetworkLoadBalancerHealths

listNetworkLoadBalancers

listNetworkLoadBalancersPolicies

listNetworkLoadBalancersProtocols

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateBackend

  • Updates the configuration of a backend server within the specified backend set. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateBackend API.

    Parameters

    Returns Promise<UpdateBackendResponse>

    UpdateBackendResponse

updateBackendSet

updateHealthChecker

updateListener

updateNetworkLoadBalancer

updateNetworkSecurityGroups