@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class ComputeManagementAsyncClient extends Object implements ComputeManagementAsync
Async client implementation for ComputeManagement service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream
, 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
Modifier and Type | Class and Description |
---|---|
static class |
ComputeManagementAsyncClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for ComputeManagement.
|
Constructor and Description |
---|
ComputeManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
ComputeManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
ComputeManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
ComputeManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
ComputeManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
ComputeManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
ComputeManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
public static final Service SERVICE
Service instance for ComputeManagement.
public ComputeManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public ComputeManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public ComputeManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public ComputeManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public ComputeManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public ComputeManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public ComputeManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public static ComputeManagementAsyncClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
ComputeManagementAsync
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface ComputeManagementAsync
endpoint
- The endpoint of the serice.public void setRegion(Region region)
ComputeManagementAsync
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.
setRegion
in interface ComputeManagementAsync
region
- The region of the service.public void setRegion(String regionId)
ComputeManagementAsync
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
.
setRegion
in interface ComputeManagementAsync
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public Future<AttachLoadBalancerResponse> attachLoadBalancer(AttachLoadBalancerRequest request, AsyncHandler<AttachLoadBalancerRequest,AttachLoadBalancerResponse> handler)
ComputeManagementAsync
Attach a load balancer to the instance pool.
attachLoadBalancer
in interface ComputeManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateInstanceConfigurationResponse> createInstanceConfiguration(CreateInstanceConfigurationRequest request, AsyncHandler<CreateInstanceConfigurationRequest,CreateInstanceConfigurationResponse> handler)
ComputeManagementAsync
Creates an instance configuration
createInstanceConfiguration
in interface ComputeManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateInstancePoolResponse> createInstancePool(CreateInstancePoolRequest request, AsyncHandler<CreateInstancePoolRequest,CreateInstancePoolResponse> handler)
ComputeManagementAsync
Create an instance pool.
createInstancePool
in interface ComputeManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteInstanceConfigurationResponse> deleteInstanceConfiguration(DeleteInstanceConfigurationRequest request, AsyncHandler<DeleteInstanceConfigurationRequest,DeleteInstanceConfigurationResponse> handler)
ComputeManagementAsync
Deletes an instance configuration.
deleteInstanceConfiguration
in interface ComputeManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DetachLoadBalancerResponse> detachLoadBalancer(DetachLoadBalancerRequest request, AsyncHandler<DetachLoadBalancerRequest,DetachLoadBalancerResponse> handler)
ComputeManagementAsync
Detach a load balancer from the instance pool.
detachLoadBalancer
in interface ComputeManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetInstanceConfigurationResponse> getInstanceConfiguration(GetInstanceConfigurationRequest request, AsyncHandler<GetInstanceConfigurationRequest,GetInstanceConfigurationResponse> handler)
ComputeManagementAsync
Gets the specified instance configuration
getInstanceConfiguration
in interface ComputeManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetInstancePoolResponse> getInstancePool(GetInstancePoolRequest request, AsyncHandler<GetInstancePoolRequest,GetInstancePoolResponse> handler)
ComputeManagementAsync
Gets the specified instance pool
getInstancePool
in interface ComputeManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<LaunchInstanceConfigurationResponse> launchInstanceConfiguration(LaunchInstanceConfigurationRequest request, AsyncHandler<LaunchInstanceConfigurationRequest,LaunchInstanceConfigurationResponse> handler)
ComputeManagementAsync
Launch an instance from an instance configuration
launchInstanceConfiguration
in interface ComputeManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListInstanceConfigurationsResponse> listInstanceConfigurations(ListInstanceConfigurationsRequest request, AsyncHandler<ListInstanceConfigurationsRequest,ListInstanceConfigurationsResponse> handler)
ComputeManagementAsync
Lists the available instanceConfigurations in the specific compartment.
listInstanceConfigurations
in interface ComputeManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListInstancePoolInstancesResponse> listInstancePoolInstances(ListInstancePoolInstancesRequest request, AsyncHandler<ListInstancePoolInstancesRequest,ListInstancePoolInstancesResponse> handler)
ComputeManagementAsync
List the instances in the specified instance pool.
listInstancePoolInstances
in interface ComputeManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListInstancePoolsResponse> listInstancePools(ListInstancePoolsRequest request, AsyncHandler<ListInstancePoolsRequest,ListInstancePoolsResponse> handler)
ComputeManagementAsync
Lists the instance pools in the specified compartment.
listInstancePools
in interface ComputeManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ResetInstancePoolResponse> resetInstancePool(ResetInstancePoolRequest request, AsyncHandler<ResetInstancePoolRequest,ResetInstancePoolResponse> handler)
ComputeManagementAsync
Performs the reset (power off and power on) action on the specified instance pool, which performs the action on all the instances in the pool.
resetInstancePool
in interface ComputeManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<SoftresetInstancePoolResponse> softresetInstancePool(SoftresetInstancePoolRequest request, AsyncHandler<SoftresetInstancePoolRequest,SoftresetInstancePoolResponse> handler)
ComputeManagementAsync
Performs the softreset (ACPI shutdown and power on) action on the specified instance pool, which performs the action on all the instances in the pool.
softresetInstancePool
in interface ComputeManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<StartInstancePoolResponse> startInstancePool(StartInstancePoolRequest request, AsyncHandler<StartInstancePoolRequest,StartInstancePoolResponse> handler)
ComputeManagementAsync
Performs the start (power on) action on the specified instance pool, which performs the action on all the instances in the pool.
startInstancePool
in interface ComputeManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<StopInstancePoolResponse> stopInstancePool(StopInstancePoolRequest request, AsyncHandler<StopInstancePoolRequest,StopInstancePoolResponse> handler)
ComputeManagementAsync
Performs the stop (power off) action on the specified instance pool, which performs the action on all the instances in the pool.
stopInstancePool
in interface ComputeManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<TerminateInstancePoolResponse> terminateInstancePool(TerminateInstancePoolRequest request, AsyncHandler<TerminateInstancePoolRequest,TerminateInstancePoolResponse> handler)
ComputeManagementAsync
Terminate the specified instance pool.
terminateInstancePool
in interface ComputeManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateInstanceConfigurationResponse> updateInstanceConfiguration(UpdateInstanceConfigurationRequest request, AsyncHandler<UpdateInstanceConfigurationRequest,UpdateInstanceConfigurationResponse> handler)
ComputeManagementAsync
Updates the freeFormTags, definedTags, and display name of an instance configuration.
updateInstanceConfiguration
in interface ComputeManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateInstancePoolResponse> updateInstancePool(UpdateInstancePoolRequest request, AsyncHandler<UpdateInstancePoolRequest,UpdateInstancePoolResponse> handler)
ComputeManagementAsync
Update the specified instance pool. The OCID of the instance pool remains the same.
updateInstancePool
in interface ComputeManagementAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2019. All rights reserved.