java.lang.Object
- com.oracle.bmc.http.internal.BaseSyncClient
- - com.oracle.bmc.networkloadbalancer.NetworkLoadBalancerClient

All Implemented Interfaces:: NetworkLoadBalancer, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200501")
public class NetworkLoadBalancerClient
extends BaseSyncClient
implements NetworkLoadBalancer

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class NetworkLoadBalancerClient.Builder
Builder class for this client.

Field Summary

Fields
Modifier and Type	Field	Description
`String`	`clientCommonLibraryVersion`	Compatible SDK version, provided by the codegen.
`Optional<String>`	`minimumClientCommonLibraryVersionFromClient`	Minimum compatible SDK version, maybe provided by the codegen.
`static Service`	`SERVICE`	Service instance for NetworkLoadBalancer.

Constructor Summary

Constructors
Constructor	Description
`NetworkLoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)`	Deprecated. Use the `builder` instead.
`NetworkLoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)`	Deprecated. Use the `builder` instead.
`NetworkLoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`NetworkLoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`NetworkLoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)`	Deprecated. Use the `builder` instead.
`NetworkLoadBalancerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)`	Deprecated. Use the `builder` instead.
`NetworkLoadBalancerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)`	Deprecated. Use the `builder` instead.
`NetworkLoadBalancerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)`	Deprecated. Use the `builder` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static NetworkLoadBalancerClient.Builder`	`builder()`	Create a builder for this client.
`ChangeNetworkLoadBalancerCompartmentResponse`	`changeNetworkLoadBalancerCompartment(ChangeNetworkLoadBalancerCompartmentRequest request)`	Moves a network load balancer into a different compartment within the same tenancy.
`void`	`close()`
`CreateBackendResponse`	`createBackend(CreateBackendRequest request)`	Adds a backend server to a backend set.
`CreateBackendSetResponse`	`createBackendSet(CreateBackendSetRequest request)`	Adds a backend set to a network load balancer.
`CreateListenerResponse`	`createListener(CreateListenerRequest request)`	Adds a listener to a network load balancer.
`CreateNetworkLoadBalancerResponse`	`createNetworkLoadBalancer(CreateNetworkLoadBalancerRequest request)`	Creates a network load balancer.
`DeleteBackendResponse`	`deleteBackend(DeleteBackendRequest request)`	Removes a backend server from a given network load balancer and backend set.
`DeleteBackendSetResponse`	`deleteBackendSet(DeleteBackendSetRequest request)`	Deletes the specified backend set.
`DeleteListenerResponse`	`deleteListener(DeleteListenerRequest request)`	Deletes a listener from a network load balancer.
`DeleteNetworkLoadBalancerResponse`	`deleteNetworkLoadBalancer(DeleteNetworkLoadBalancerRequest request)`	Deletes a network load balancer resource by identifier.
`void`	`enableDualStackEndpoints(boolean enableDualStackEndpoints)`	This method should be used to enable or disable the use of dual-stack endpoints.
`GetBackendResponse`	`getBackend(GetBackendRequest request)`	Retrieves the configuration information for the specified backend server.
`GetBackendHealthResponse`	`getBackendHealth(GetBackendHealthRequest request)`	Retrieves the current health status of the specified backend server.
`GetBackendOperationalStatusResponse`	`getBackendOperationalStatus(GetBackendOperationalStatusRequest request)`	Retrieves the current operational status of the specified backend server.
`GetBackendSetResponse`	`getBackendSet(GetBackendSetRequest request)`	Retrieves the configuration information for the specified backend set.
`GetBackendSetHealthResponse`	`getBackendSetHealth(GetBackendSetHealthRequest request)`	Retrieves the health status for the specified backend set.
`String`	`getClientCommonLibraryVersion()`
`protected ClientConfigurator`	`getDefaultConfigurator()`
`String`	`getEndpoint()`	Get the endpoint of the client.
`GetHealthCheckerResponse`	`getHealthChecker(GetHealthCheckerRequest request)`	Retrieves the health check policy information for a given network load balancer and backend set.
`GetListenerResponse`	`getListener(GetListenerRequest request)`	Retrieves listener properties associated with a given network load balancer and listener name.
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`GetNetworkLoadBalancerResponse`	`getNetworkLoadBalancer(GetNetworkLoadBalancerRequest request)`	Retrieves network load balancer configuration information by identifier.
`GetNetworkLoadBalancerHealthResponse`	`getNetworkLoadBalancerHealth(GetNetworkLoadBalancerHealthRequest request)`	Retrieves the health status for the specified network load balancer.
`Map<String,Boolean>`	`getOptionsMap()`	Return an immutable snapshot representing the current options set for this client.
`NetworkLoadBalancerPaginators`	`getPaginators()`	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`String`	`getResolvedEndpoint(Map<String,Object> requiredParametersMap)`	Returns the endpoint after filling in the current options, as determined by `BaseClient.getOptionsMap()`, and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
`NetworkLoadBalancerWaiters`	`getWaiters()`	Gets the pre-configured waiters available for resources for this service.
`GetWorkRequestResponse`	`getWorkRequest(GetWorkRequestRequest request)`	Retrieves the details of the work request with the given identifier.
`ListBackendsResponse`	`listBackends(ListBackendsRequest request)`	Lists the backend servers for a given network load balancer and backend set.
`ListBackendSetsResponse`	`listBackendSets(ListBackendSetsRequest request)`	Lists all backend sets associated with a given network load balancer.
`ListListenersResponse`	`listListeners(ListListenersRequest request)`	Lists all listeners associated with a given network load balancer.
`ListNetworkLoadBalancerHealthsResponse`	`listNetworkLoadBalancerHealths(ListNetworkLoadBalancerHealthsRequest request)`	Lists the summary health statuses for all network load balancers in the specified compartment.
`ListNetworkLoadBalancersResponse`	`listNetworkLoadBalancers(ListNetworkLoadBalancersRequest request)`	Returns a list of network load balancers.
`ListNetworkLoadBalancersPoliciesResponse`	`listNetworkLoadBalancersPolicies(ListNetworkLoadBalancersPoliciesRequest request)`	Lists the available network load balancer policies.
`ListNetworkLoadBalancersProtocolsResponse`	`listNetworkLoadBalancersProtocols(ListNetworkLoadBalancersProtocolsRequest request)`	This API has been deprecated so it won’t return the updated list of supported protocls.
`ListWorkRequestErrorsResponse`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request)`	Return a (paginated) list of errors for a given work request.
`ListWorkRequestLogsResponse`	`listWorkRequestLogs(ListWorkRequestLogsRequest request)`	Returns a (paginated) list of logs for a given work request.
`ListWorkRequestsResponse`	`listWorkRequests(ListWorkRequestsRequest request)`	Lists all work requests.
`void`	`refreshClient()`	Rebuild the backing `HttpClient`.
`void`	`setEndpoint(String endpoint)`
`void`	`setRegion(Region region)`	Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)`	Sets the region to call (ex, ‘us-phoenix-1’).
`UpdateBackendResponse`	`updateBackend(UpdateBackendRequest request)`	Updates the configuration of a backend server within the specified backend set.
`UpdateBackendSetResponse`	`updateBackendSet(UpdateBackendSetRequest request)`	Updates a backend set.
`UpdateHealthCheckerResponse`	`updateHealthChecker(UpdateHealthCheckerRequest request)`	Updates the health check policy for a given network load balancer and backend set.
`UpdateListenerResponse`	`updateListener(UpdateListenerRequest request)`	Updates a listener for a given network load balancer.
`UpdateNetworkLoadBalancerResponse`	`updateNetworkLoadBalancer(UpdateNetworkLoadBalancerRequest request)`	Updates the network load balancer
`UpdateNetworkSecurityGroupsResponse`	`updateNetworkSecurityGroups(UpdateNetworkSecurityGroupsRequest request)`	Updates the network security groups associated with the specified network load balancer.
`void`	`useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)`	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable
close

Methods inherited from interface com.oracle.bmc.networkloadbalancer.NetworkLoadBalancer
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for NetworkLoadBalancer.
  - clientCommonLibraryVersion
```
public final String clientCommonLibraryVersion
```
    Compatible SDK version, provided by the codegen.
  - minimumClientCommonLibraryVersionFromClient
```
public final Optional<String> minimumClientCommonLibraryVersionFromClient
```
    Minimum compatible SDK version, maybe provided by the codegen.
- Constructor Detail
  - NetworkLoadBalancerClient
```
@Deprecated
public NetworkLoadBalancerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see NetworkLoadBalancerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - NetworkLoadBalancerClient
```
@Deprecated
public NetworkLoadBalancerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see NetworkLoadBalancerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - NetworkLoadBalancerClient
```
@Deprecated
public NetworkLoadBalancerClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see NetworkLoadBalancerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - NetworkLoadBalancerClient
```
@Deprecated
public NetworkLoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see NetworkLoadBalancerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
  - NetworkLoadBalancerClient
```
@Deprecated
public NetworkLoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory,
                                 List<ClientConfigurator> additionalClientConfigurators)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see NetworkLoadBalancerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - NetworkLoadBalancerClient
```
@Deprecated
public NetworkLoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory,
                                 List<ClientConfigurator> additionalClientConfigurators,
                                 String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see NetworkLoadBalancerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
  - NetworkLoadBalancerClient
```
@Deprecated
public NetworkLoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory,
                                 Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                 List<ClientConfigurator> additionalClientConfigurators,
                                 String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see NetworkLoadBalancerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
    
    signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories
  - NetworkLoadBalancerClient
```
@Deprecated
public NetworkLoadBalancerClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory,
                                 Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                 List<ClientConfigurator> additionalClientConfigurators,
                                 String endpoint,
                                 ExecutorService executorService)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see NetworkLoadBalancerClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
    
    signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories
    
    executorService - NetworkLoadBalancerClient.Builder.executorService
- Method Detail
  - builder
```
public static NetworkLoadBalancerClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: NetworkLoadBalancer
    
    Sets the region to call (ex, Region.US_PHOENIX_1).
    Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
    
    Specified by:
    
    setRegion in interface NetworkLoadBalancer
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: NetworkLoadBalancer
    
    Sets the region to call (ex, ‘us-phoenix-1’).
    Note, this will first try to map the region ID to a known Region and call setRegion.
    If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.
    
    Specified by:
    
    setRegion in interface NetworkLoadBalancer
    
    Parameters:
    
    regionId - The public region ID.
  - changeNetworkLoadBalancerCompartment
```
public ChangeNetworkLoadBalancerCompartmentResponse changeNetworkLoadBalancerCompartment(ChangeNetworkLoadBalancerCompartmentRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Moves a network load balancer into a different compartment within the same tenancy.
    For information about moving resources between compartments, see Moving Resources to a Different Compartment.
    
    Specified by:
    
    changeNetworkLoadBalancerCompartment in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createBackend
```
public CreateBackendResponse createBackend(CreateBackendRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Adds a backend server to a backend set.
    
    Specified by:
    
    createBackend in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createBackendSet
```
public CreateBackendSetResponse createBackendSet(CreateBackendSetRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Adds a backend set to a network load balancer.
    
    Specified by:
    
    createBackendSet in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createListener
```
public CreateListenerResponse createListener(CreateListenerRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Adds a listener to a network load balancer.
    
    Specified by:
    
    createListener in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createNetworkLoadBalancer
```
public CreateNetworkLoadBalancerResponse createNetworkLoadBalancer(CreateNetworkLoadBalancerRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Creates a network load balancer.
    
    Specified by:
    
    createNetworkLoadBalancer in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteBackend
```
public DeleteBackendResponse deleteBackend(DeleteBackendRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Removes a backend server from a given network load balancer and backend set.
    
    Specified by:
    
    deleteBackend in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteBackendSet
```
public DeleteBackendSetResponse deleteBackendSet(DeleteBackendSetRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    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.
    
    Specified by:
    
    deleteBackendSet in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteListener
```
public DeleteListenerResponse deleteListener(DeleteListenerRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Deletes a listener from a network load balancer.
    
    Specified by:
    
    deleteListener in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteNetworkLoadBalancer
```
public DeleteNetworkLoadBalancerResponse deleteNetworkLoadBalancer(DeleteNetworkLoadBalancerRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Deletes a network load balancer resource by identifier.
    
    Specified by:
    
    deleteNetworkLoadBalancer in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getBackend
```
public GetBackendResponse getBackend(GetBackendRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Retrieves the configuration information for the specified backend server.
    
    Specified by:
    
    getBackend in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getBackendHealth
```
public GetBackendHealthResponse getBackendHealth(GetBackendHealthRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Retrieves the current health status of the specified backend server.
    
    Specified by:
    
    getBackendHealth in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getBackendOperationalStatus
```
public GetBackendOperationalStatusResponse getBackendOperationalStatus(GetBackendOperationalStatusRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Retrieves the current operational status of the specified backend server.
    
    Specified by:
    
    getBackendOperationalStatus in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getBackendSet
```
public GetBackendSetResponse getBackendSet(GetBackendSetRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Retrieves the configuration information for the specified backend set.
    
    Specified by:
    
    getBackendSet in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getBackendSetHealth
```
public GetBackendSetHealthResponse getBackendSetHealth(GetBackendSetHealthRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Retrieves the health status for the specified backend set.
    
    Specified by:
    
    getBackendSetHealth in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getHealthChecker
```
public GetHealthCheckerResponse getHealthChecker(GetHealthCheckerRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Retrieves the health check policy information for a given network load balancer and backend set.
    
    Specified by:
    
    getHealthChecker in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getListener
```
public GetListenerResponse getListener(GetListenerRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Retrieves listener properties associated with a given network load balancer and listener name.
    
    Specified by:
    
    getListener in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getNetworkLoadBalancer
```
public GetNetworkLoadBalancerResponse getNetworkLoadBalancer(GetNetworkLoadBalancerRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Retrieves network load balancer configuration information by identifier.
    
    Specified by:
    
    getNetworkLoadBalancer in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getNetworkLoadBalancerHealth
```
public GetNetworkLoadBalancerHealthResponse getNetworkLoadBalancerHealth(GetNetworkLoadBalancerHealthRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Retrieves the health status for the specified network load balancer.
    
    Specified by:
    
    getNetworkLoadBalancerHealth in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWorkRequest
```
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Retrieves the details of the work request with the given identifier.
    
    Specified by:
    
    getWorkRequest in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listBackendSets
```
public ListBackendSetsResponse listBackendSets(ListBackendSetsRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Lists all backend sets associated with a given network load balancer.
    
    Specified by:
    
    listBackendSets in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listBackends
```
public ListBackendsResponse listBackends(ListBackendsRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Lists the backend servers for a given network load balancer and backend set.
    
    Specified by:
    
    listBackends in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listListeners
```
public ListListenersResponse listListeners(ListListenersRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Lists all listeners associated with a given network load balancer.
    
    Specified by:
    
    listListeners in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listNetworkLoadBalancerHealths
```
public ListNetworkLoadBalancerHealthsResponse listNetworkLoadBalancerHealths(ListNetworkLoadBalancerHealthsRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Lists the summary health statuses for all network load balancers in the specified compartment.
    
    Specified by:
    
    listNetworkLoadBalancerHealths in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listNetworkLoadBalancers
```
public ListNetworkLoadBalancersResponse listNetworkLoadBalancers(ListNetworkLoadBalancersRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Returns a list of network load balancers.
    
    Specified by:
    
    listNetworkLoadBalancers in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listNetworkLoadBalancersPolicies
```
public ListNetworkLoadBalancersPoliciesResponse listNetworkLoadBalancersPolicies(ListNetworkLoadBalancersPoliciesRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Lists the available network load balancer policies.
    
    Specified by:
    
    listNetworkLoadBalancersPolicies in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listNetworkLoadBalancersProtocols
```
public ListNetworkLoadBalancersProtocolsResponse listNetworkLoadBalancersProtocols(ListNetworkLoadBalancersProtocolsRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    This API has been deprecated so it won’t return the updated list of supported protocls.
    Lists all supported traffic protocols.
    
    Specified by:
    
    listNetworkLoadBalancersProtocols in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestErrors
```
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Return a (paginated) list of errors for a given work request.
    
    Specified by:
    
    listWorkRequestErrors in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestLogs
```
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Returns a (paginated) list of logs for a given work request.
    
    Specified by:
    
    listWorkRequestLogs in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequests
```
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Lists all work requests.
    
    Specified by:
    
    listWorkRequests in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateBackend
```
public UpdateBackendResponse updateBackend(UpdateBackendRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Updates the configuration of a backend server within the specified backend set.
    
    Specified by:
    
    updateBackend in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateBackendSet
```
public UpdateBackendSetResponse updateBackendSet(UpdateBackendSetRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Updates a backend set.
    
    Specified by:
    
    updateBackendSet in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateHealthChecker
```
public UpdateHealthCheckerResponse updateHealthChecker(UpdateHealthCheckerRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Updates the health check policy for a given network load balancer and backend set.
    
    Specified by:
    
    updateHealthChecker in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateListener
```
public UpdateListenerResponse updateListener(UpdateListenerRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Updates a listener for a given network load balancer.
    
    Specified by:
    
    updateListener in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateNetworkLoadBalancer
```
public UpdateNetworkLoadBalancerResponse updateNetworkLoadBalancer(UpdateNetworkLoadBalancerRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Updates the network load balancer
    
    Specified by:
    
    updateNetworkLoadBalancer in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateNetworkSecurityGroups
```
public UpdateNetworkSecurityGroupsResponse updateNetworkSecurityGroups(UpdateNetworkSecurityGroupsRequest request)
```
    Description copied from interface: NetworkLoadBalancer
    
    Updates the network security groups associated with the specified network load balancer.
    
    Specified by:
    
    updateNetworkSecurityGroups in interface NetworkLoadBalancer
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public NetworkLoadBalancerWaiters getWaiters()
```
    Description copied from interface: NetworkLoadBalancer
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface NetworkLoadBalancer
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public NetworkLoadBalancerPaginators getPaginators()
```
    Description copied from interface: NetworkLoadBalancer
    
    Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
    These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
    
    Specified by:
    
    getPaginators in interface NetworkLoadBalancer
    
    Returns:
    
    The service paginators.
  - getDefaultConfigurator
```
protected ClientConfigurator getDefaultConfigurator()
```
  - enableDualStackEndpoints
```
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
```
    This method should be used to enable or disable the use of dual-stack endpoints.
    The default value is false i.e. dual-stack endpoints are disabled by default.
    
    Parameters:
    
    enableDualStackEndpoints - This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
  - getOptionsMap
```
public Map<String,Boolean> getOptionsMap()
```
    Return an immutable snapshot representing the current options set for this client.
    
    Returns:
    
    immutable snapshot representing the current options set for this client
  - getResolvedEndpoint
```
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
```
    Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
    
    Parameters:
    
    requiredParametersMap - the map from required parameter name to their values
    
    Returns:
    
    resolved endpoint, with all options and placeholders filled in
  - useRealmSpecificEndpointTemplate
```
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
```
    This method should be used to enable or disable the use of realm-specific endpoint template.
    The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
    
    Parameters:
    
    useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
  - setEndpoint
```
public final void setEndpoint(String endpoint)
```
  - getEndpoint
```
public final String getEndpoint()
```
    Get the endpoint of the client.
    Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a Region.
    Examples of endpoints this may return:
    
    Unparameterized endpoints
    https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com
    
    Parameterized endpoints with placeholders
    https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com
    
    Parameterized endpoints with options
    https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com
    
    Parameterized endpoints with placeholders and options
    https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
    
    To get the actual endpoint for a parameterized request, you can use BaseClient.getResolvedEndpoint(Map) or ParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).
    Returns:
    
    the endpoint being used by the client
  - refreshClient
```
public final void refreshClient()
```
    Rebuild the backing HttpClient.
    This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
  - close
```
public final void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - getClientCommonLibraryVersion
```
public String getClientCommonLibraryVersion()
```
  - getMinimumClientCommonLibraryVersionFromClient
```
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
```

Class NetworkLoadBalancerClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.AutoCloseable

Methods inherited from interface com.oracle.bmc.networkloadbalancer.NetworkLoadBalancer

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

NetworkLoadBalancerClient

NetworkLoadBalancerClient

NetworkLoadBalancerClient

NetworkLoadBalancerClient

NetworkLoadBalancerClient

NetworkLoadBalancerClient

NetworkLoadBalancerClient

NetworkLoadBalancerClient

Method Detail

builder

setRegion

setRegion

changeNetworkLoadBalancerCompartment

createBackend

createBackendSet

createListener

createNetworkLoadBalancer

deleteBackend

deleteBackendSet

deleteListener

deleteNetworkLoadBalancer

getBackend

getBackendHealth

getBackendOperationalStatus

getBackendSet

getBackendSetHealth

getHealthChecker

getListener

getNetworkLoadBalancer

getNetworkLoadBalancerHealth

getWorkRequest

listBackendSets

listBackends

listListeners

listNetworkLoadBalancerHealths

listNetworkLoadBalancers

listNetworkLoadBalancersPolicies

listNetworkLoadBalancersProtocols

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

updateBackend

updateBackendSet

updateHealthChecker

updateListener

updateNetworkLoadBalancer

updateNetworkSecurityGroups

getWaiters

getPaginators

getDefaultConfigurator

enableDualStackEndpoints

getOptionsMap

getResolvedEndpoint

useRealmSpecificEndpointTemplate

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient