Class DatastoreClusterAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.ocvp.DatastoreClusterAsyncClient
-
- All Implemented Interfaces:
DatastoreClusterAsync
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20230701") public class DatastoreClusterAsyncClient extends BaseAsyncClient implements DatastoreClusterAsync
Async client implementation for DatastoreCluster 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
DatastoreClusterAsyncClient.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 DatastoreCluster.
-
Constructor Summary
Constructors Constructor Description DatastoreClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.DatastoreClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.DatastoreClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DatastoreClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DatastoreClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.DatastoreClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.DatastoreClusterAsyncClient(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.ocvp.DatastoreClusterAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DatastoreClusterAsyncClient
@Deprecated public DatastoreClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDatastoreClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
DatastoreClusterAsyncClient
@Deprecated public DatastoreClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDatastoreClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
DatastoreClusterAsyncClient
@Deprecated public DatastoreClusterAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDatastoreClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DatastoreClusterAsyncClient
@Deprecated public DatastoreClusterAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDatastoreClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
DatastoreClusterAsyncClient
@Deprecated public DatastoreClusterAsyncClient(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 (seeDatastoreClusterAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
DatastoreClusterAsyncClient
@Deprecated public DatastoreClusterAsyncClient(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 (seeDatastoreClusterAsyncClient.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)
-
DatastoreClusterAsyncClient
@Deprecated public DatastoreClusterAsyncClient(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 (seeDatastoreClusterAsyncClient.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 DatastoreClusterAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:DatastoreClusterAsync
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 interfaceDatastoreClusterAsync
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DatastoreClusterAsync
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 interfaceDatastoreClusterAsync
- Parameters:
regionId
- The public region ID.
-
addDatastoreToDatastoreCluster
public Future<AddDatastoreToDatastoreClusterResponse> addDatastoreToDatastoreCluster(AddDatastoreToDatastoreClusterRequest request, AsyncHandler<AddDatastoreToDatastoreClusterRequest,AddDatastoreToDatastoreClusterResponse> handler)
Description copied from interface:DatastoreClusterAsync
Add the specified Datastore to the provided Datastore Cluster.- Specified by:
addDatastoreToDatastoreCluster
in interfaceDatastoreClusterAsync
- 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.
-
attachDatastoreClusterToCluster
public Future<AttachDatastoreClusterToClusterResponse> attachDatastoreClusterToCluster(AttachDatastoreClusterToClusterRequest request, AsyncHandler<AttachDatastoreClusterToClusterRequest,AttachDatastoreClusterToClusterResponse> handler)
Description copied from interface:DatastoreClusterAsync
Attach the specified Datastore Cluster to the provided Vmware Cluster.Use the
WorkRequest
operations to track the attachment of the Datastore.- Specified by:
attachDatastoreClusterToCluster
in interfaceDatastoreClusterAsync
- 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.
-
attachDatastoreClusterToEsxiHost
public Future<AttachDatastoreClusterToEsxiHostResponse> attachDatastoreClusterToEsxiHost(AttachDatastoreClusterToEsxiHostRequest request, AsyncHandler<AttachDatastoreClusterToEsxiHostRequest,AttachDatastoreClusterToEsxiHostResponse> handler)
Description copied from interface:DatastoreClusterAsync
Attach the specified Datastore Cluster to the provided ESXi Hosts.Use the
WorkRequest
operations to track the attachment of the Datastore.- Specified by:
attachDatastoreClusterToEsxiHost
in interfaceDatastoreClusterAsync
- 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.
-
changeDatastoreClusterCompartment
public Future<ChangeDatastoreClusterCompartmentResponse> changeDatastoreClusterCompartment(ChangeDatastoreClusterCompartmentRequest request, AsyncHandler<ChangeDatastoreClusterCompartmentRequest,ChangeDatastoreClusterCompartmentResponse> handler)
Description copied from interface:DatastoreClusterAsync
Moves an Datastore Cluster into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeDatastoreClusterCompartment
in interfaceDatastoreClusterAsync
- 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.
-
createDatastoreCluster
public Future<CreateDatastoreClusterResponse> createDatastoreCluster(CreateDatastoreClusterRequest request, AsyncHandler<CreateDatastoreClusterRequest,CreateDatastoreClusterResponse> handler)
Description copied from interface:DatastoreClusterAsync
Creates a Oracle Cloud VMware Solution Datastore Cluster.- Specified by:
createDatastoreCluster
in interfaceDatastoreClusterAsync
- 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.
-
deleteDatastoreCluster
public Future<DeleteDatastoreClusterResponse> deleteDatastoreCluster(DeleteDatastoreClusterRequest request, AsyncHandler<DeleteDatastoreClusterRequest,DeleteDatastoreClusterResponse> handler)
Description copied from interface:DatastoreClusterAsync
Deletes the specified Datastore Cluster.- Specified by:
deleteDatastoreCluster
in interfaceDatastoreClusterAsync
- 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.
-
detachDatastoreClusterFromCluster
public Future<DetachDatastoreClusterFromClusterResponse> detachDatastoreClusterFromCluster(DetachDatastoreClusterFromClusterRequest request, AsyncHandler<DetachDatastoreClusterFromClusterRequest,DetachDatastoreClusterFromClusterResponse> handler)
Description copied from interface:DatastoreClusterAsync
Detach the specified Datastore Cluster from the provided Vmware Cluster.Use the
WorkRequest
operations to track the detachment of the Datastore.- Specified by:
detachDatastoreClusterFromCluster
in interfaceDatastoreClusterAsync
- 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.
-
detachDatastoreClusterFromEsxiHost
public Future<DetachDatastoreClusterFromEsxiHostResponse> detachDatastoreClusterFromEsxiHost(DetachDatastoreClusterFromEsxiHostRequest request, AsyncHandler<DetachDatastoreClusterFromEsxiHostRequest,DetachDatastoreClusterFromEsxiHostResponse> handler)
Description copied from interface:DatastoreClusterAsync
Detach the specified Datastore Cluster from the provided ESXi Hosts.Use the
WorkRequest
operations to track the detachment of the Datastore.- Specified by:
detachDatastoreClusterFromEsxiHost
in interfaceDatastoreClusterAsync
- 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.
-
getDatastoreCluster
public Future<GetDatastoreClusterResponse> getDatastoreCluster(GetDatastoreClusterRequest request, AsyncHandler<GetDatastoreClusterRequest,GetDatastoreClusterResponse> handler)
Description copied from interface:DatastoreClusterAsync
Get the specified Datastore Cluster information.- Specified by:
getDatastoreCluster
in interfaceDatastoreClusterAsync
- 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.
-
listDatastoreClusters
public Future<ListDatastoreClustersResponse> listDatastoreClusters(ListDatastoreClustersRequest request, AsyncHandler<ListDatastoreClustersRequest,ListDatastoreClustersResponse> handler)
Description copied from interface:DatastoreClusterAsync
List the Datastore Clusters in the specified compartment.The list can be filtered by compartment, Datastore Cluster, Display name and Lifecycle state
- Specified by:
listDatastoreClusters
in interfaceDatastoreClusterAsync
- 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.
-
removeDatastoreFromDatastoreCluster
public Future<RemoveDatastoreFromDatastoreClusterResponse> removeDatastoreFromDatastoreCluster(RemoveDatastoreFromDatastoreClusterRequest request, AsyncHandler<RemoveDatastoreFromDatastoreClusterRequest,RemoveDatastoreFromDatastoreClusterResponse> handler)
Description copied from interface:DatastoreClusterAsync
Remove the specified Datastore from the provided Datastore Cluster.- Specified by:
removeDatastoreFromDatastoreCluster
in interfaceDatastoreClusterAsync
- 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.
-
updateDatastoreCluster
public Future<UpdateDatastoreClusterResponse> updateDatastoreCluster(UpdateDatastoreClusterRequest request, AsyncHandler<UpdateDatastoreClusterRequest,UpdateDatastoreClusterResponse> handler)
Description copied from interface:DatastoreClusterAsync
Updates the specified Datastore Cluster.*Important:** Updating a Datastore Cluster affects only certain attributes in the `Datastore Cluster` object and does not affect the VMware environment currently running.
- Specified by:
updateDatastoreCluster
in interfaceDatastoreClusterAsync
- 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)
-
-