Class NetworkLoadBalancerAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.networkloadbalancer.NetworkLoadBalancerAsyncClient
-
- All Implemented Interfaces:
NetworkLoadBalancerAsync
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20200501") public class NetworkLoadBalancerAsyncClient extends BaseAsyncClient implements NetworkLoadBalancerAsync
Async client implementation for NetworkLoadBalancer service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is anInputStream
, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
NetworkLoadBalancerAsyncClient.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 NetworkLoadBalancerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.NetworkLoadBalancerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.NetworkLoadBalancerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.NetworkLoadBalancerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.NetworkLoadBalancerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.NetworkLoadBalancerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.NetworkLoadBalancerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
-
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.NetworkLoadBalancerAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
NetworkLoadBalancerAsyncClient
@Deprecated public NetworkLoadBalancerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeNetworkLoadBalancerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
NetworkLoadBalancerAsyncClient
@Deprecated public NetworkLoadBalancerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeNetworkLoadBalancerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
NetworkLoadBalancerAsyncClient
@Deprecated public NetworkLoadBalancerAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeNetworkLoadBalancerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
NetworkLoadBalancerAsyncClient
@Deprecated public NetworkLoadBalancerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeNetworkLoadBalancerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
NetworkLoadBalancerAsyncClient
@Deprecated public NetworkLoadBalancerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeNetworkLoadBalancerAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
NetworkLoadBalancerAsyncClient
@Deprecated public NetworkLoadBalancerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeNetworkLoadBalancerAsyncClient.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)
-
NetworkLoadBalancerAsyncClient
@Deprecated public NetworkLoadBalancerAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeNetworkLoadBalancerAsyncClient.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
-
-
Method Detail
-
builder
public static NetworkLoadBalancerAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:NetworkLoadBalancerAsync
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 interfaceNetworkLoadBalancerAsync
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:NetworkLoadBalancerAsync
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 callsetEndpoint
.- Specified by:
setRegion
in interfaceNetworkLoadBalancerAsync
- Parameters:
regionId
- The public region ID.
-
changeNetworkLoadBalancerCompartment
public Future<ChangeNetworkLoadBalancerCompartmentResponse> changeNetworkLoadBalancerCompartment(ChangeNetworkLoadBalancerCompartmentRequest request, AsyncHandler<ChangeNetworkLoadBalancerCompartmentRequest,ChangeNetworkLoadBalancerCompartmentResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
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 interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createBackend
public Future<CreateBackendResponse> createBackend(CreateBackendRequest request, AsyncHandler<CreateBackendRequest,CreateBackendResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Adds a backend server to a backend set.- Specified by:
createBackend
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createBackendSet
public Future<CreateBackendSetResponse> createBackendSet(CreateBackendSetRequest request, AsyncHandler<CreateBackendSetRequest,CreateBackendSetResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Adds a backend set to a network load balancer.- Specified by:
createBackendSet
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createListener
public Future<CreateListenerResponse> createListener(CreateListenerRequest request, AsyncHandler<CreateListenerRequest,CreateListenerResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Adds a listener to a network load balancer.- Specified by:
createListener
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createNetworkLoadBalancer
public Future<CreateNetworkLoadBalancerResponse> createNetworkLoadBalancer(CreateNetworkLoadBalancerRequest request, AsyncHandler<CreateNetworkLoadBalancerRequest,CreateNetworkLoadBalancerResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Creates a network load balancer.- Specified by:
createNetworkLoadBalancer
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteBackend
public Future<DeleteBackendResponse> deleteBackend(DeleteBackendRequest request, AsyncHandler<DeleteBackendRequest,DeleteBackendResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Removes a backend server from a given network load balancer and backend set.- Specified by:
deleteBackend
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteBackendSet
public Future<DeleteBackendSetResponse> deleteBackendSet(DeleteBackendSetRequest request, AsyncHandler<DeleteBackendSetRequest,DeleteBackendSetResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
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 interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteListener
public Future<DeleteListenerResponse> deleteListener(DeleteListenerRequest request, AsyncHandler<DeleteListenerRequest,DeleteListenerResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Deletes a listener from a network load balancer.- Specified by:
deleteListener
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteNetworkLoadBalancer
public Future<DeleteNetworkLoadBalancerResponse> deleteNetworkLoadBalancer(DeleteNetworkLoadBalancerRequest request, AsyncHandler<DeleteNetworkLoadBalancerRequest,DeleteNetworkLoadBalancerResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Deletes a network load balancer resource by identifier.- Specified by:
deleteNetworkLoadBalancer
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getBackend
public Future<GetBackendResponse> getBackend(GetBackendRequest request, AsyncHandler<GetBackendRequest,GetBackendResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Retrieves the configuration information for the specified backend server.- Specified by:
getBackend
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getBackendHealth
public Future<GetBackendHealthResponse> getBackendHealth(GetBackendHealthRequest request, AsyncHandler<GetBackendHealthRequest,GetBackendHealthResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Retrieves the current health status of the specified backend server.- Specified by:
getBackendHealth
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getBackendOperationalStatus
public Future<GetBackendOperationalStatusResponse> getBackendOperationalStatus(GetBackendOperationalStatusRequest request, AsyncHandler<GetBackendOperationalStatusRequest,GetBackendOperationalStatusResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Retrieves the current operational status of the specified backend server.- Specified by:
getBackendOperationalStatus
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getBackendSet
public Future<GetBackendSetResponse> getBackendSet(GetBackendSetRequest request, AsyncHandler<GetBackendSetRequest,GetBackendSetResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Retrieves the configuration information for the specified backend set.- Specified by:
getBackendSet
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getBackendSetHealth
public Future<GetBackendSetHealthResponse> getBackendSetHealth(GetBackendSetHealthRequest request, AsyncHandler<GetBackendSetHealthRequest,GetBackendSetHealthResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Retrieves the health status for the specified backend set.- Specified by:
getBackendSetHealth
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getHealthChecker
public Future<GetHealthCheckerResponse> getHealthChecker(GetHealthCheckerRequest request, AsyncHandler<GetHealthCheckerRequest,GetHealthCheckerResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Retrieves the health check policy information for a given network load balancer and backend set.- Specified by:
getHealthChecker
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getListener
public Future<GetListenerResponse> getListener(GetListenerRequest request, AsyncHandler<GetListenerRequest,GetListenerResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Retrieves listener properties associated with a given network load balancer and listener name.- Specified by:
getListener
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getNetworkLoadBalancer
public Future<GetNetworkLoadBalancerResponse> getNetworkLoadBalancer(GetNetworkLoadBalancerRequest request, AsyncHandler<GetNetworkLoadBalancerRequest,GetNetworkLoadBalancerResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Retrieves network load balancer configuration information by identifier.- Specified by:
getNetworkLoadBalancer
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getNetworkLoadBalancerHealth
public Future<GetNetworkLoadBalancerHealthResponse> getNetworkLoadBalancerHealth(GetNetworkLoadBalancerHealthRequest request, AsyncHandler<GetNetworkLoadBalancerHealthRequest,GetNetworkLoadBalancerHealthResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Retrieves the health status for the specified network load balancer.- Specified by:
getNetworkLoadBalancerHealth
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getWorkRequest
public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Retrieves the details of the work request with the given identifier.- Specified by:
getWorkRequest
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listBackendSets
public Future<ListBackendSetsResponse> listBackendSets(ListBackendSetsRequest request, AsyncHandler<ListBackendSetsRequest,ListBackendSetsResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Lists all backend sets associated with a given network load balancer.- Specified by:
listBackendSets
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listBackends
public Future<ListBackendsResponse> listBackends(ListBackendsRequest request, AsyncHandler<ListBackendsRequest,ListBackendsResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Lists the backend servers for a given network load balancer and backend set.- Specified by:
listBackends
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listListeners
public Future<ListListenersResponse> listListeners(ListListenersRequest request, AsyncHandler<ListListenersRequest,ListListenersResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Lists all listeners associated with a given network load balancer.- Specified by:
listListeners
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listNetworkLoadBalancerHealths
public Future<ListNetworkLoadBalancerHealthsResponse> listNetworkLoadBalancerHealths(ListNetworkLoadBalancerHealthsRequest request, AsyncHandler<ListNetworkLoadBalancerHealthsRequest,ListNetworkLoadBalancerHealthsResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Lists the summary health statuses for all network load balancers in the specified compartment.- Specified by:
listNetworkLoadBalancerHealths
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listNetworkLoadBalancers
public Future<ListNetworkLoadBalancersResponse> listNetworkLoadBalancers(ListNetworkLoadBalancersRequest request, AsyncHandler<ListNetworkLoadBalancersRequest,ListNetworkLoadBalancersResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Returns a list of network load balancers.- Specified by:
listNetworkLoadBalancers
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listNetworkLoadBalancersPolicies
public Future<ListNetworkLoadBalancersPoliciesResponse> listNetworkLoadBalancersPolicies(ListNetworkLoadBalancersPoliciesRequest request, AsyncHandler<ListNetworkLoadBalancersPoliciesRequest,ListNetworkLoadBalancersPoliciesResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Lists the available network load balancer policies.- Specified by:
listNetworkLoadBalancersPolicies
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listNetworkLoadBalancersProtocols
public Future<ListNetworkLoadBalancersProtocolsResponse> listNetworkLoadBalancersProtocols(ListNetworkLoadBalancersProtocolsRequest request, AsyncHandler<ListNetworkLoadBalancersProtocolsRequest,ListNetworkLoadBalancersProtocolsResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
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 interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listWorkRequestErrors
public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Return a (paginated) list of errors for a given work request.- Specified by:
listWorkRequestErrors
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listWorkRequestLogs
public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Returns a (paginated) list of logs for a given work request.- Specified by:
listWorkRequestLogs
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listWorkRequests
public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Lists all work requests.- Specified by:
listWorkRequests
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateBackend
public Future<UpdateBackendResponse> updateBackend(UpdateBackendRequest request, AsyncHandler<UpdateBackendRequest,UpdateBackendResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Updates the configuration of a backend server within the specified backend set.- Specified by:
updateBackend
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateBackendSet
public Future<UpdateBackendSetResponse> updateBackendSet(UpdateBackendSetRequest request, AsyncHandler<UpdateBackendSetRequest,UpdateBackendSetResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Updates a backend set.- Specified by:
updateBackendSet
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateHealthChecker
public Future<UpdateHealthCheckerResponse> updateHealthChecker(UpdateHealthCheckerRequest request, AsyncHandler<UpdateHealthCheckerRequest,UpdateHealthCheckerResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Updates the health check policy for a given network load balancer and backend set.- Specified by:
updateHealthChecker
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateListener
public Future<UpdateListenerResponse> updateListener(UpdateListenerRequest request, AsyncHandler<UpdateListenerRequest,UpdateListenerResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Updates a listener for a given network load balancer.- Specified by:
updateListener
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateNetworkLoadBalancer
public Future<UpdateNetworkLoadBalancerResponse> updateNetworkLoadBalancer(UpdateNetworkLoadBalancerRequest request, AsyncHandler<UpdateNetworkLoadBalancerRequest,UpdateNetworkLoadBalancerResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Updates the network load balancer- Specified by:
updateNetworkLoadBalancer
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateNetworkSecurityGroups
public Future<UpdateNetworkSecurityGroupsResponse> updateNetworkSecurityGroups(UpdateNetworkSecurityGroupsRequest request, AsyncHandler<UpdateNetworkSecurityGroupsRequest,UpdateNetworkSecurityGroupsResponse> handler)
Description copied from interface:NetworkLoadBalancerAsync
Updates the network security groups associated with the specified network load balancer.- Specified by:
updateNetworkSecurityGroups
in interfaceNetworkLoadBalancerAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
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
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint
- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
getMinimumClientCommonLibraryVersionFromClient
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
-
clientCall
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
-
-