@Generated(value="OracleSDKGenerator", comments="API Version: 20220125") public class DisasterRecoveryAsyncClient extends BaseAsyncClient implements DisasterRecoveryAsync
Async client implementation for DisasterRecovery 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 |
DisasterRecoveryAsyncClient.Builder
Builder class for this client.
|
Modifier and Type | Field and 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 DisasterRecovery.
|
Constructor and Description |
---|
DisasterRecoveryAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
DisasterRecoveryAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
DisasterRecoveryAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
DisasterRecoveryAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
DisasterRecoveryAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
DisasterRecoveryAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
DisasterRecoveryAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for DisasterRecovery.
public final String clientCommonLibraryVersion
@Deprecated public DisasterRecoveryAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DisasterRecoveryAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public DisasterRecoveryAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DisasterRecoveryAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public DisasterRecoveryAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DisasterRecoveryAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public DisasterRecoveryAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DisasterRecoveryAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public DisasterRecoveryAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DisasterRecoveryAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public DisasterRecoveryAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DisasterRecoveryAsyncClient.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)
@Deprecated public DisasterRecoveryAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DisasterRecoveryAsyncClient.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
public static DisasterRecoveryAsyncClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
DisasterRecoveryAsync
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 DisasterRecoveryAsync
region
- The region of the service.public void setRegion(String regionId)
DisasterRecoveryAsync
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 DisasterRecoveryAsync
regionId
- The public region ID.public Future<AssociateDrProtectionGroupResponse> associateDrProtectionGroup(AssociateDrProtectionGroupRequest request, AsyncHandler<AssociateDrProtectionGroupRequest,AssociateDrProtectionGroupResponse> handler)
DisasterRecoveryAsync
Create an association between the DR protection group identified by drProtectionGroupId and another DR protection group.
associateDrProtectionGroup
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CancelDrPlanExecutionResponse> cancelDrPlanExecution(CancelDrPlanExecutionRequest request, AsyncHandler<CancelDrPlanExecutionRequest,CancelDrPlanExecutionResponse> handler)
DisasterRecoveryAsync
Cancel the DR plan execution identified by drPlanExecutionId.
cancelDrPlanExecution
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)
DisasterRecoveryAsync
Cancel the work request identified by workRequestId.
cancelWorkRequest
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ChangeDrProtectionGroupCompartmentResponse> changeDrProtectionGroupCompartment(ChangeDrProtectionGroupCompartmentRequest request, AsyncHandler<ChangeDrProtectionGroupCompartmentRequest,ChangeDrProtectionGroupCompartmentResponse> handler)
DisasterRecoveryAsync
Move the DR protection group identified by drProtectionGroupId to a different compartment.
changeDrProtectionGroupCompartment
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateDrPlanResponse> createDrPlan(CreateDrPlanRequest request, AsyncHandler<CreateDrPlanRequest,CreateDrPlanResponse> handler)
DisasterRecoveryAsync
Create a DR plan of the specified DR plan type.
createDrPlan
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateDrPlanExecutionResponse> createDrPlanExecution(CreateDrPlanExecutionRequest request, AsyncHandler<CreateDrPlanExecutionRequest,CreateDrPlanExecutionResponse> handler)
DisasterRecoveryAsync
Execute a DR plan for a DR protection group.
createDrPlanExecution
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateDrProtectionGroupResponse> createDrProtectionGroup(CreateDrProtectionGroupRequest request, AsyncHandler<CreateDrProtectionGroupRequest,CreateDrProtectionGroupResponse> handler)
DisasterRecoveryAsync
Create a DR protection group.
createDrProtectionGroup
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteDrPlanResponse> deleteDrPlan(DeleteDrPlanRequest request, AsyncHandler<DeleteDrPlanRequest,DeleteDrPlanResponse> handler)
DisasterRecoveryAsync
Delete the DR plan identified by drPlanId.
deleteDrPlan
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteDrPlanExecutionResponse> deleteDrPlanExecution(DeleteDrPlanExecutionRequest request, AsyncHandler<DeleteDrPlanExecutionRequest,DeleteDrPlanExecutionResponse> handler)
DisasterRecoveryAsync
Delete the DR plan execution identified by drPlanExecutionId.
deleteDrPlanExecution
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteDrProtectionGroupResponse> deleteDrProtectionGroup(DeleteDrProtectionGroupRequest request, AsyncHandler<DeleteDrProtectionGroupRequest,DeleteDrProtectionGroupResponse> handler)
DisasterRecoveryAsync
Delete the DR protection group identified by drProtectionGroupId.
deleteDrProtectionGroup
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DisassociateDrProtectionGroupResponse> disassociateDrProtectionGroup(DisassociateDrProtectionGroupRequest request, AsyncHandler<DisassociateDrProtectionGroupRequest,DisassociateDrProtectionGroupResponse> handler)
DisasterRecoveryAsync
Delete the association between the DR protection group identified by drProtectionGroupId. and its peer DR protection group.
disassociateDrProtectionGroup
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetDrPlanResponse> getDrPlan(GetDrPlanRequest request, AsyncHandler<GetDrPlanRequest,GetDrPlanResponse> handler)
DisasterRecoveryAsync
Get details for the DR plan identified by drPlanId.
getDrPlan
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetDrPlanExecutionResponse> getDrPlanExecution(GetDrPlanExecutionRequest request, AsyncHandler<GetDrPlanExecutionRequest,GetDrPlanExecutionResponse> handler)
DisasterRecoveryAsync
Get details for the DR plan execution identified by drPlanExecutionId.
getDrPlanExecution
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetDrProtectionGroupResponse> getDrProtectionGroup(GetDrProtectionGroupRequest request, AsyncHandler<GetDrProtectionGroupRequest,GetDrProtectionGroupResponse> handler)
DisasterRecoveryAsync
Get the DR protection group identified by drProtectionGroupId.
getDrProtectionGroup
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
DisasterRecoveryAsync
Get the status of the work request identified by workRequestId.
getWorkRequest
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<IgnoreDrPlanExecutionResponse> ignoreDrPlanExecution(IgnoreDrPlanExecutionRequest request, AsyncHandler<IgnoreDrPlanExecutionRequest,IgnoreDrPlanExecutionResponse> handler)
DisasterRecoveryAsync
Ignore the failed group or step in DR plan execution identified by drPlanExecutionId and resume execution.
ignoreDrPlanExecution
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListDrPlanExecutionsResponse> listDrPlanExecutions(ListDrPlanExecutionsRequest request, AsyncHandler<ListDrPlanExecutionsRequest,ListDrPlanExecutionsResponse> handler)
DisasterRecoveryAsync
Get a summary list of all DR plan executions for a DR protection group.
listDrPlanExecutions
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListDrPlansResponse> listDrPlans(ListDrPlansRequest request, AsyncHandler<ListDrPlansRequest,ListDrPlansResponse> handler)
DisasterRecoveryAsync
Get a summary list of all DR plans for a DR protection group.
listDrPlans
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListDrProtectionGroupsResponse> listDrProtectionGroups(ListDrProtectionGroupsRequest request, AsyncHandler<ListDrProtectionGroupsRequest,ListDrProtectionGroupsResponse> handler)
DisasterRecoveryAsync
Get a summary list of all DR protection groups in a compartment.
listDrProtectionGroups
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
DisasterRecoveryAsync
Get a list of work request errors for the work request identified by workRequestId.
listWorkRequestErrors
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
DisasterRecoveryAsync
Get a list of logs for the work request identified by workRequestId.
listWorkRequestLogs
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
DisasterRecoveryAsync
Lists the work requests in a compartment.
listWorkRequests
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<PauseDrPlanExecutionResponse> pauseDrPlanExecution(PauseDrPlanExecutionRequest request, AsyncHandler<PauseDrPlanExecutionRequest,PauseDrPlanExecutionResponse> handler)
DisasterRecoveryAsync
Pause the DR plan execution identified by drPlanExecutionId.
pauseDrPlanExecution
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ResumeDrPlanExecutionResponse> resumeDrPlanExecution(ResumeDrPlanExecutionRequest request, AsyncHandler<ResumeDrPlanExecutionRequest,ResumeDrPlanExecutionResponse> handler)
DisasterRecoveryAsync
Resume the DR plan execution identified by drPlanExecutionId.
resumeDrPlanExecution
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<RetryDrPlanExecutionResponse> retryDrPlanExecution(RetryDrPlanExecutionRequest request, AsyncHandler<RetryDrPlanExecutionRequest,RetryDrPlanExecutionResponse> handler)
DisasterRecoveryAsync
Retry the failed group or step in DR plan execution identified by drPlanExecutionId and resume execution.
retryDrPlanExecution
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateDrPlanResponse> updateDrPlan(UpdateDrPlanRequest request, AsyncHandler<UpdateDrPlanRequest,UpdateDrPlanResponse> handler)
DisasterRecoveryAsync
Update the DR plan identified by drPlanId.
updateDrPlan
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateDrPlanExecutionResponse> updateDrPlanExecution(UpdateDrPlanExecutionRequest request, AsyncHandler<UpdateDrPlanExecutionRequest,UpdateDrPlanExecutionResponse> handler)
DisasterRecoveryAsync
Update the DR plan execution identified by drPlanExecutionId.
updateDrPlanExecution
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateDrProtectionGroupResponse> updateDrProtectionGroup(UpdateDrProtectionGroupRequest request, AsyncHandler<UpdateDrProtectionGroupRequest,UpdateDrProtectionGroupResponse> handler)
DisasterRecoveryAsync
Update the DR protection group identified by drProtectionGroupId.
updateDrProtectionGroup
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateDrProtectionGroupRoleResponse> updateDrProtectionGroupRole(UpdateDrProtectionGroupRoleRequest request, AsyncHandler<UpdateDrProtectionGroupRoleRequest,UpdateDrProtectionGroupRoleResponse> handler)
DisasterRecoveryAsync
Update the role of the DR protection group identified by drProtectionGroupId.
updateDrProtectionGroupRole
in interface DisasterRecoveryAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public String getClientCommonLibraryVersion()
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
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)
Copyright © 2016–2024. All rights reserved.