Class ComputeManagementAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.core.ComputeManagementAsyncClient
-
- All Implemented Interfaces:
ComputeManagementAsync
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class ComputeManagementAsyncClient extends BaseAsyncClient 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 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
ComputeManagementAsyncClient.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 ComputeManagement.
-
Constructor Summary
Constructors Constructor Description ComputeManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.ComputeManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.ComputeManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.ComputeManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.ComputeManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.ComputeManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.ComputeManagementAsyncClient(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.core.ComputeManagementAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
ComputeManagementAsyncClient
@Deprecated public ComputeManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeComputeManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
ComputeManagementAsyncClient
@Deprecated public ComputeManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeComputeManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
ComputeManagementAsyncClient
@Deprecated public ComputeManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeComputeManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
ComputeManagementAsyncClient
@Deprecated public ComputeManagementAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeComputeManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
ComputeManagementAsyncClient
@Deprecated public ComputeManagementAsyncClient(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 (seeComputeManagementAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
ComputeManagementAsyncClient
@Deprecated public ComputeManagementAsyncClient(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 (seeComputeManagementAsyncClient.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)
-
ComputeManagementAsyncClient
@Deprecated public ComputeManagementAsyncClient(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 (seeComputeManagementAsyncClient.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 ComputeManagementAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface: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.- Specified by:
setRegion
in interfaceComputeManagementAsync
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface: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 callsetEndpoint
.- Specified by:
setRegion
in interfaceComputeManagementAsync
- Parameters:
regionId
- The public region ID.
-
attachInstancePoolInstance
public Future<AttachInstancePoolInstanceResponse> attachInstancePoolInstance(AttachInstancePoolInstanceRequest request, AsyncHandler<AttachInstancePoolInstanceRequest,AttachInstancePoolInstanceResponse> handler)
Description copied from interface:ComputeManagementAsync
Attaches an instance to an instance pool.For information about the prerequisites that an instance must meet before you can attach it to a pool, see Attaching an Instance to an Instance Pool.
- Specified by:
attachInstancePoolInstance
in interfaceComputeManagementAsync
- 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.
-
attachLoadBalancer
public Future<AttachLoadBalancerResponse> attachLoadBalancer(AttachLoadBalancerRequest request, AsyncHandler<AttachLoadBalancerRequest,AttachLoadBalancerResponse> handler)
Description copied from interface:ComputeManagementAsync
Attach a load balancer to the instance pool.- Specified by:
attachLoadBalancer
in interfaceComputeManagementAsync
- 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.
-
changeClusterNetworkCompartment
public Future<ChangeClusterNetworkCompartmentResponse> changeClusterNetworkCompartment(ChangeClusterNetworkCompartmentRequest request, AsyncHandler<ChangeClusterNetworkCompartmentRequest,ChangeClusterNetworkCompartmentResponse> handler)
Description copied from interface:ComputeManagementAsync
Moves a cluster network with instance pools into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
When you move a cluster network to a different compartment, associated resources such as the instances in the cluster network, boot volumes, and VNICs are not moved.
- Specified by:
changeClusterNetworkCompartment
in interfaceComputeManagementAsync
- 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.
-
changeInstanceConfigurationCompartment
public Future<ChangeInstanceConfigurationCompartmentResponse> changeInstanceConfigurationCompartment(ChangeInstanceConfigurationCompartmentRequest request, AsyncHandler<ChangeInstanceConfigurationCompartmentRequest,ChangeInstanceConfigurationCompartmentResponse> handler)
Description copied from interface:ComputeManagementAsync
Moves an instance configuration into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
When you move an instance configuration to a different compartment, associated resources such as instance pools are not moved.
*Important:** Most of the properties for an existing instance configuration, including the compartment, cannot be modified after you create the instance configuration. Although you can move an instance configuration to a different compartment, you will not be able to use the instance configuration to manage instance pools in the new compartment. If you want to update an instance configuration to point to a different compartment, you should instead create a new instance configuration in the target compartment using [CreateInstanceConfiguration](https://docs.oracle.com/iaas/api/#/en/iaas/20160918/InstanceConfiguration/CreateInstanceConfiguration).
- Specified by:
changeInstanceConfigurationCompartment
in interfaceComputeManagementAsync
- 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.
-
changeInstancePoolCompartment
public Future<ChangeInstancePoolCompartmentResponse> changeInstancePoolCompartment(ChangeInstancePoolCompartmentRequest request, AsyncHandler<ChangeInstancePoolCompartmentRequest,ChangeInstancePoolCompartmentResponse> handler)
Description copied from interface:ComputeManagementAsync
Moves an instance pool into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
When you move an instance pool to a different compartment, associated resources such as the instances in the pool, boot volumes, VNICs, and autoscaling configurations are not moved.
- Specified by:
changeInstancePoolCompartment
in interfaceComputeManagementAsync
- 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.
-
createClusterNetwork
public Future<CreateClusterNetworkResponse> createClusterNetwork(CreateClusterNetworkRequest request, AsyncHandler<CreateClusterNetworkRequest,CreateClusterNetworkResponse> handler)
Description copied from interface:ComputeManagementAsync
Creates a cluster network with instance pools.A cluster network is a group of high performance computing (HPC), GPU, or optimized bare metal instances that are connected with an ultra low-latency remote direct memory access (RDMA) network. Cluster networks with instance pools use instance pools to manage groups of identical instances.
Use cluster networks with instance pools when you want predictable capacity for a specific number of identical instances that are managed as a group.
If you want to manage instances in the RDMA network independently of each other or use different types of instances in the network group, create a compute cluster by using the
createComputeCluster
operation.To determine whether capacity is available for a specific shape before you create a cluster network, use the
createComputeCapacityReport
operation.- Specified by:
createClusterNetwork
in interfaceComputeManagementAsync
- 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.
-
createInstanceConfiguration
public Future<CreateInstanceConfigurationResponse> createInstanceConfiguration(CreateInstanceConfigurationRequest request, AsyncHandler<CreateInstanceConfigurationRequest,CreateInstanceConfigurationResponse> handler)
Description copied from interface:ComputeManagementAsync
Creates an instance configuration.An instance configuration is a template that defines the settings to use when creating Compute instances.
- Specified by:
createInstanceConfiguration
in interfaceComputeManagementAsync
- 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.
-
createInstancePool
public Future<CreateInstancePoolResponse> createInstancePool(CreateInstancePoolRequest request, AsyncHandler<CreateInstancePoolRequest,CreateInstancePoolResponse> handler)
Description copied from interface:ComputeManagementAsync
Creates an instance pool.To determine whether capacity is available for a specific shape before you create an instance pool, use the
createComputeCapacityReport
operation.- Specified by:
createInstancePool
in interfaceComputeManagementAsync
- 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.
-
deleteInstanceConfiguration
public Future<DeleteInstanceConfigurationResponse> deleteInstanceConfiguration(DeleteInstanceConfigurationRequest request, AsyncHandler<DeleteInstanceConfigurationRequest,DeleteInstanceConfigurationResponse> handler)
Description copied from interface:ComputeManagementAsync
Deletes an instance configuration.- Specified by:
deleteInstanceConfiguration
in interfaceComputeManagementAsync
- 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.
-
detachInstancePoolInstance
public Future<DetachInstancePoolInstanceResponse> detachInstancePoolInstance(DetachInstancePoolInstanceRequest request, AsyncHandler<DetachInstancePoolInstanceRequest,DetachInstancePoolInstanceResponse> handler)
Description copied from interface:ComputeManagementAsync
Detaches an instance from an instance pool.- Specified by:
detachInstancePoolInstance
in interfaceComputeManagementAsync
- 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.
-
detachLoadBalancer
public Future<DetachLoadBalancerResponse> detachLoadBalancer(DetachLoadBalancerRequest request, AsyncHandler<DetachLoadBalancerRequest,DetachLoadBalancerResponse> handler)
Description copied from interface:ComputeManagementAsync
Detach a load balancer from the instance pool.- Specified by:
detachLoadBalancer
in interfaceComputeManagementAsync
- 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.
-
getClusterNetwork
public Future<GetClusterNetworkResponse> getClusterNetwork(GetClusterNetworkRequest request, AsyncHandler<GetClusterNetworkRequest,GetClusterNetworkResponse> handler)
Description copied from interface:ComputeManagementAsync
Gets information about a cluster network with instance pools.- Specified by:
getClusterNetwork
in interfaceComputeManagementAsync
- 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.
-
getInstanceConfiguration
public Future<GetInstanceConfigurationResponse> getInstanceConfiguration(GetInstanceConfigurationRequest request, AsyncHandler<GetInstanceConfigurationRequest,GetInstanceConfigurationResponse> handler)
Description copied from interface:ComputeManagementAsync
Gets the specified instance configuration- Specified by:
getInstanceConfiguration
in interfaceComputeManagementAsync
- 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.
-
getInstancePool
public Future<GetInstancePoolResponse> getInstancePool(GetInstancePoolRequest request, AsyncHandler<GetInstancePoolRequest,GetInstancePoolResponse> handler)
Description copied from interface:ComputeManagementAsync
Gets the specified instance pool- Specified by:
getInstancePool
in interfaceComputeManagementAsync
- 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.
-
getInstancePoolInstance
public Future<GetInstancePoolInstanceResponse> getInstancePoolInstance(GetInstancePoolInstanceRequest request, AsyncHandler<GetInstancePoolInstanceRequest,GetInstancePoolInstanceResponse> handler)
Description copied from interface:ComputeManagementAsync
Gets information about an instance that belongs to an instance pool.- Specified by:
getInstancePoolInstance
in interfaceComputeManagementAsync
- 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.
-
getInstancePoolLoadBalancerAttachment
public Future<GetInstancePoolLoadBalancerAttachmentResponse> getInstancePoolLoadBalancerAttachment(GetInstancePoolLoadBalancerAttachmentRequest request, AsyncHandler<GetInstancePoolLoadBalancerAttachmentRequest,GetInstancePoolLoadBalancerAttachmentResponse> handler)
Description copied from interface:ComputeManagementAsync
Gets information about a load balancer that is attached to the specified instance pool.- Specified by:
getInstancePoolLoadBalancerAttachment
in interfaceComputeManagementAsync
- 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.
-
launchInstanceConfiguration
public Future<LaunchInstanceConfigurationResponse> launchInstanceConfiguration(LaunchInstanceConfigurationRequest request, AsyncHandler<LaunchInstanceConfigurationRequest,LaunchInstanceConfigurationResponse> handler)
Description copied from interface:ComputeManagementAsync
Creates an instance from an instance configuration.If the instance configuration does not include all of the parameters that are required to create an instance, such as the availability domain and subnet ID, you must provide these parameters when you create an instance from the instance configuration. For more information, see the
InstanceConfiguration
resource.To determine whether capacity is available for a specific shape before you create an instance, use the
createComputeCapacityReport
operation.- Specified by:
launchInstanceConfiguration
in interfaceComputeManagementAsync
- 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.
-
listClusterNetworkInstances
public Future<ListClusterNetworkInstancesResponse> listClusterNetworkInstances(ListClusterNetworkInstancesRequest request, AsyncHandler<ListClusterNetworkInstancesRequest,ListClusterNetworkInstancesResponse> handler)
Description copied from interface:ComputeManagementAsync
Lists the instances in a cluster network with instance pools.- Specified by:
listClusterNetworkInstances
in interfaceComputeManagementAsync
- 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.
-
listClusterNetworks
public Future<ListClusterNetworksResponse> listClusterNetworks(ListClusterNetworksRequest request, AsyncHandler<ListClusterNetworksRequest,ListClusterNetworksResponse> handler)
Description copied from interface:ComputeManagementAsync
Lists the cluster networks with instance pools in the specified compartment.- Specified by:
listClusterNetworks
in interfaceComputeManagementAsync
- 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.
-
listInstanceConfigurations
public Future<ListInstanceConfigurationsResponse> listInstanceConfigurations(ListInstanceConfigurationsRequest request, AsyncHandler<ListInstanceConfigurationsRequest,ListInstanceConfigurationsResponse> handler)
Description copied from interface:ComputeManagementAsync
Lists the instance configurations in the specified compartment.- Specified by:
listInstanceConfigurations
in interfaceComputeManagementAsync
- 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.
-
listInstancePoolInstances
public Future<ListInstancePoolInstancesResponse> listInstancePoolInstances(ListInstancePoolInstancesRequest request, AsyncHandler<ListInstancePoolInstancesRequest,ListInstancePoolInstancesResponse> handler)
Description copied from interface:ComputeManagementAsync
List the instances in the specified instance pool.- Specified by:
listInstancePoolInstances
in interfaceComputeManagementAsync
- 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.
-
listInstancePools
public Future<ListInstancePoolsResponse> listInstancePools(ListInstancePoolsRequest request, AsyncHandler<ListInstancePoolsRequest,ListInstancePoolsResponse> handler)
Description copied from interface:ComputeManagementAsync
Lists the instance pools in the specified compartment.- Specified by:
listInstancePools
in interfaceComputeManagementAsync
- 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.
-
resetInstancePool
public Future<ResetInstancePoolResponse> resetInstancePool(ResetInstancePoolRequest request, AsyncHandler<ResetInstancePoolRequest,ResetInstancePoolResponse> handler)
Description copied from interface:ComputeManagementAsync
Performs the reset (immediate power off and power on) action on the specified instance pool, which performs the action on all the instances in the pool.- Specified by:
resetInstancePool
in interfaceComputeManagementAsync
- 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.
-
softresetInstancePool
public Future<SoftresetInstancePoolResponse> softresetInstancePool(SoftresetInstancePoolRequest request, AsyncHandler<SoftresetInstancePoolRequest,SoftresetInstancePoolResponse> handler)
Description copied from interface: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.Softreset gracefully reboots the instances by sending a shutdown command to the operating systems. After waiting 15 minutes for the OS to shut down, the instances are powered off and then powered back on.
- Specified by:
softresetInstancePool
in interfaceComputeManagementAsync
- 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.
-
softstopInstancePool
public Future<SoftstopInstancePoolResponse> softstopInstancePool(SoftstopInstancePoolRequest request, AsyncHandler<SoftstopInstancePoolRequest,SoftstopInstancePoolResponse> handler)
Description copied from interface:ComputeManagementAsync
Performs the softstop (ACPI shutdown and power on) action on the specified instance pool, which performs the action on all the instances in the pool.Softstop gracefully reboots the instances by sending a shutdown command to the operating systems. After waiting 15 minutes for the OS to shutdown, the instances are powered off and then powered back on.
- Specified by:
softstopInstancePool
in interfaceComputeManagementAsync
- 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.
-
startInstancePool
public Future<StartInstancePoolResponse> startInstancePool(StartInstancePoolRequest request, AsyncHandler<StartInstancePoolRequest,StartInstancePoolResponse> handler)
Description copied from interface:ComputeManagementAsync
Performs the start (power on) action on the specified instance pool, which performs the action on all the instances in the pool.- Specified by:
startInstancePool
in interfaceComputeManagementAsync
- 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.
-
stopInstancePool
public Future<StopInstancePoolResponse> stopInstancePool(StopInstancePoolRequest request, AsyncHandler<StopInstancePoolRequest,StopInstancePoolResponse> handler)
Description copied from interface:ComputeManagementAsync
Performs the stop (immediate power off) action on the specified instance pool, which performs the action on all the instances in the pool.- Specified by:
stopInstancePool
in interfaceComputeManagementAsync
- 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.
-
terminateClusterNetwork
public Future<TerminateClusterNetworkResponse> terminateClusterNetwork(TerminateClusterNetworkRequest request, AsyncHandler<TerminateClusterNetworkRequest,TerminateClusterNetworkResponse> handler)
Description copied from interface:ComputeManagementAsync
Deletes (terminates) a cluster network with instance pools.When you delete a cluster network, all of its resources are permanently deleted, including associated instances and instance pools.
- Specified by:
terminateClusterNetwork
in interfaceComputeManagementAsync
- 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.
-
terminateInstancePool
public Future<TerminateInstancePoolResponse> terminateInstancePool(TerminateInstancePoolRequest request, AsyncHandler<TerminateInstancePoolRequest,TerminateInstancePoolResponse> handler)
Description copied from interface:ComputeManagementAsync
Terminate the specified instance pool.*Warning:** When you delete an instance pool, the resources that were created by the pool are permanently deleted, including associated instances, attached boot volumes, and block volumes.
If an autoscaling configuration applies to the instance pool, the autoscaling configuration will be deleted asynchronously after the pool is deleted. You can also manually delete the autoscaling configuration using the `DeleteAutoScalingConfiguration` operation in the Autoscaling API.
- Specified by:
terminateInstancePool
in interfaceComputeManagementAsync
- 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.
-
updateClusterNetwork
public Future<UpdateClusterNetworkResponse> updateClusterNetwork(UpdateClusterNetworkRequest request, AsyncHandler<UpdateClusterNetworkRequest,UpdateClusterNetworkResponse> handler)
Description copied from interface:ComputeManagementAsync
Updates a cluster network with instance pools.The OCID of the cluster network remains the same.
- Specified by:
updateClusterNetwork
in interfaceComputeManagementAsync
- 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.
-
updateInstanceConfiguration
public Future<UpdateInstanceConfigurationResponse> updateInstanceConfiguration(UpdateInstanceConfigurationRequest request, AsyncHandler<UpdateInstanceConfigurationRequest,UpdateInstanceConfigurationResponse> handler)
Description copied from interface:ComputeManagementAsync
Updates the free-form tags, defined tags, and display name of an instance configuration.- Specified by:
updateInstanceConfiguration
in interfaceComputeManagementAsync
- 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.
-
updateInstancePool
public Future<UpdateInstancePoolResponse> updateInstancePool(UpdateInstancePoolRequest request, AsyncHandler<UpdateInstancePoolRequest,UpdateInstancePoolResponse> handler)
Description copied from interface:ComputeManagementAsync
Update the specified instance pool.The OCID of the instance pool remains the same.
- Specified by:
updateInstancePool
in interfaceComputeManagementAsync
- 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)
-
-