Class DisasterRecoveryAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.disasterrecovery.DisasterRecoveryAsyncClient
-
- All Implemented Interfaces:
DisasterRecoveryAsync
,AutoCloseable
@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 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
DisasterRecoveryAsyncClient.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 DisasterRecovery.
-
Constructor Summary
Constructors Constructor Description DisasterRecoveryAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.DisasterRecoveryAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.DisasterRecoveryAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DisasterRecoveryAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DisasterRecoveryAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.DisasterRecoveryAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.DisasterRecoveryAsyncClient(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.disasterrecovery.DisasterRecoveryAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DisasterRecoveryAsyncClient
@Deprecated public DisasterRecoveryAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDisasterRecoveryAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
DisasterRecoveryAsyncClient
@Deprecated public DisasterRecoveryAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDisasterRecoveryAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
DisasterRecoveryAsyncClient
@Deprecated public DisasterRecoveryAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDisasterRecoveryAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DisasterRecoveryAsyncClient
@Deprecated public DisasterRecoveryAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDisasterRecoveryAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
DisasterRecoveryAsyncClient
@Deprecated public DisasterRecoveryAsyncClient(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 (seeDisasterRecoveryAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
DisasterRecoveryAsyncClient
@Deprecated public DisasterRecoveryAsyncClient(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 (seeDisasterRecoveryAsyncClient.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)
-
DisasterRecoveryAsyncClient
@Deprecated public DisasterRecoveryAsyncClient(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 (seeDisasterRecoveryAsyncClient.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 DisasterRecoveryAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface: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.- Specified by:
setRegion
in interfaceDisasterRecoveryAsync
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface: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 callsetEndpoint
.- Specified by:
setRegion
in interfaceDisasterRecoveryAsync
- Parameters:
regionId
- The public region ID.
-
associateDrProtectionGroup
public Future<AssociateDrProtectionGroupResponse> associateDrProtectionGroup(AssociateDrProtectionGroupRequest request, AsyncHandler<AssociateDrProtectionGroupRequest,AssociateDrProtectionGroupResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Create an association between the DR protection group identified by drProtectionGroupId and another DR protection group.- Specified by:
associateDrProtectionGroup
in interfaceDisasterRecoveryAsync
- 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.
-
cancelDrPlanExecution
public Future<CancelDrPlanExecutionResponse> cancelDrPlanExecution(CancelDrPlanExecutionRequest request, AsyncHandler<CancelDrPlanExecutionRequest,CancelDrPlanExecutionResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Cancel the DR plan execution identified by drPlanExecutionId.- Specified by:
cancelDrPlanExecution
in interfaceDisasterRecoveryAsync
- 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.
-
cancelWorkRequest
public Future<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Cancel the work request identified by workRequestId.- Specified by:
cancelWorkRequest
in interfaceDisasterRecoveryAsync
- 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.
-
changeDrProtectionGroupCompartment
public Future<ChangeDrProtectionGroupCompartmentResponse> changeDrProtectionGroupCompartment(ChangeDrProtectionGroupCompartmentRequest request, AsyncHandler<ChangeDrProtectionGroupCompartmentRequest,ChangeDrProtectionGroupCompartmentResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Move the DR protection group identified by drProtectionGroupId to a different compartment.- Specified by:
changeDrProtectionGroupCompartment
in interfaceDisasterRecoveryAsync
- 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.
-
createDrPlan
public Future<CreateDrPlanResponse> createDrPlan(CreateDrPlanRequest request, AsyncHandler<CreateDrPlanRequest,CreateDrPlanResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Create a DR plan of the specified DR plan type.- Specified by:
createDrPlan
in interfaceDisasterRecoveryAsync
- 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.
-
createDrPlanExecution
public Future<CreateDrPlanExecutionResponse> createDrPlanExecution(CreateDrPlanExecutionRequest request, AsyncHandler<CreateDrPlanExecutionRequest,CreateDrPlanExecutionResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Execute a DR plan for a DR protection group.- Specified by:
createDrPlanExecution
in interfaceDisasterRecoveryAsync
- 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.
-
createDrProtectionGroup
public Future<CreateDrProtectionGroupResponse> createDrProtectionGroup(CreateDrProtectionGroupRequest request, AsyncHandler<CreateDrProtectionGroupRequest,CreateDrProtectionGroupResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Create a DR protection group.- Specified by:
createDrProtectionGroup
in interfaceDisasterRecoveryAsync
- 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.
-
deleteDrPlan
public Future<DeleteDrPlanResponse> deleteDrPlan(DeleteDrPlanRequest request, AsyncHandler<DeleteDrPlanRequest,DeleteDrPlanResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Delete the DR plan identified by drPlanId.- Specified by:
deleteDrPlan
in interfaceDisasterRecoveryAsync
- 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.
-
deleteDrPlanExecution
public Future<DeleteDrPlanExecutionResponse> deleteDrPlanExecution(DeleteDrPlanExecutionRequest request, AsyncHandler<DeleteDrPlanExecutionRequest,DeleteDrPlanExecutionResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Delete the DR plan execution identified by drPlanExecutionId.- Specified by:
deleteDrPlanExecution
in interfaceDisasterRecoveryAsync
- 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.
-
deleteDrProtectionGroup
public Future<DeleteDrProtectionGroupResponse> deleteDrProtectionGroup(DeleteDrProtectionGroupRequest request, AsyncHandler<DeleteDrProtectionGroupRequest,DeleteDrProtectionGroupResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Delete the DR protection group identified by drProtectionGroupId.- Specified by:
deleteDrProtectionGroup
in interfaceDisasterRecoveryAsync
- 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.
-
disassociateDrProtectionGroup
public Future<DisassociateDrProtectionGroupResponse> disassociateDrProtectionGroup(DisassociateDrProtectionGroupRequest request, AsyncHandler<DisassociateDrProtectionGroupRequest,DisassociateDrProtectionGroupResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Delete the association between the DR protection group identified by drProtectionGroupId.and its peer DR protection group.
- Specified by:
disassociateDrProtectionGroup
in interfaceDisasterRecoveryAsync
- 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.
-
getDrPlan
public Future<GetDrPlanResponse> getDrPlan(GetDrPlanRequest request, AsyncHandler<GetDrPlanRequest,GetDrPlanResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Get details for the DR plan identified by drPlanId.- Specified by:
getDrPlan
in interfaceDisasterRecoveryAsync
- 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.
-
getDrPlanExecution
public Future<GetDrPlanExecutionResponse> getDrPlanExecution(GetDrPlanExecutionRequest request, AsyncHandler<GetDrPlanExecutionRequest,GetDrPlanExecutionResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Get details for the DR plan execution identified by drPlanExecutionId.- Specified by:
getDrPlanExecution
in interfaceDisasterRecoveryAsync
- 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.
-
getDrProtectionGroup
public Future<GetDrProtectionGroupResponse> getDrProtectionGroup(GetDrProtectionGroupRequest request, AsyncHandler<GetDrProtectionGroupRequest,GetDrProtectionGroupResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Get the DR protection group identified by drProtectionGroupId.- Specified by:
getDrProtectionGroup
in interfaceDisasterRecoveryAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getWorkRequest
public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Get the status of the work request identified by workRequestId.- Specified by:
getWorkRequest
in interfaceDisasterRecoveryAsync
- 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.
-
ignoreDrPlanExecution
public Future<IgnoreDrPlanExecutionResponse> ignoreDrPlanExecution(IgnoreDrPlanExecutionRequest request, AsyncHandler<IgnoreDrPlanExecutionRequest,IgnoreDrPlanExecutionResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Ignore the failed group or step in DR plan execution identified by drPlanExecutionId and resume execution.- Specified by:
ignoreDrPlanExecution
in interfaceDisasterRecoveryAsync
- 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.
-
listDrPlanExecutions
public Future<ListDrPlanExecutionsResponse> listDrPlanExecutions(ListDrPlanExecutionsRequest request, AsyncHandler<ListDrPlanExecutionsRequest,ListDrPlanExecutionsResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Get a summary list of all DR plan executions for a DR protection group.- Specified by:
listDrPlanExecutions
in interfaceDisasterRecoveryAsync
- 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.
-
listDrPlans
public Future<ListDrPlansResponse> listDrPlans(ListDrPlansRequest request, AsyncHandler<ListDrPlansRequest,ListDrPlansResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Get a summary list of all DR plans for a DR protection group.- Specified by:
listDrPlans
in interfaceDisasterRecoveryAsync
- 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.
-
listDrProtectionGroups
public Future<ListDrProtectionGroupsResponse> listDrProtectionGroups(ListDrProtectionGroupsRequest request, AsyncHandler<ListDrProtectionGroupsRequest,ListDrProtectionGroupsResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Get a summary list of all DR protection groups in a compartment.- Specified by:
listDrProtectionGroups
in interfaceDisasterRecoveryAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listWorkRequestErrors
public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Get a list of work request errors for the work request identified by workRequestId.- Specified by:
listWorkRequestErrors
in interfaceDisasterRecoveryAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listWorkRequestLogs
public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Get a list of logs for the work request identified by workRequestId.- Specified by:
listWorkRequestLogs
in interfaceDisasterRecoveryAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listWorkRequests
public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Lists the work requests in a compartment.- Specified by:
listWorkRequests
in interfaceDisasterRecoveryAsync
- 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.
-
pauseDrPlanExecution
public Future<PauseDrPlanExecutionResponse> pauseDrPlanExecution(PauseDrPlanExecutionRequest request, AsyncHandler<PauseDrPlanExecutionRequest,PauseDrPlanExecutionResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Pause the DR plan execution identified by drPlanExecutionId.- Specified by:
pauseDrPlanExecution
in interfaceDisasterRecoveryAsync
- 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.
-
refreshDrPlan
public Future<RefreshDrPlanResponse> refreshDrPlan(RefreshDrPlanRequest request, AsyncHandler<RefreshDrPlanRequest,RefreshDrPlanResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Refresh DR Plan identified by drPlanId.- Specified by:
refreshDrPlan
in interfaceDisasterRecoveryAsync
- 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.
-
resumeDrPlanExecution
public Future<ResumeDrPlanExecutionResponse> resumeDrPlanExecution(ResumeDrPlanExecutionRequest request, AsyncHandler<ResumeDrPlanExecutionRequest,ResumeDrPlanExecutionResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Resume the DR plan execution identified by drPlanExecutionId.- Specified by:
resumeDrPlanExecution
in interfaceDisasterRecoveryAsync
- 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.
-
retryDrPlanExecution
public Future<RetryDrPlanExecutionResponse> retryDrPlanExecution(RetryDrPlanExecutionRequest request, AsyncHandler<RetryDrPlanExecutionRequest,RetryDrPlanExecutionResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Retry the failed group or step in DR plan execution identified by drPlanExecutionId and resume execution.- Specified by:
retryDrPlanExecution
in interfaceDisasterRecoveryAsync
- 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.
-
updateDrPlan
public Future<UpdateDrPlanResponse> updateDrPlan(UpdateDrPlanRequest request, AsyncHandler<UpdateDrPlanRequest,UpdateDrPlanResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Update the DR plan identified by drPlanId.- Specified by:
updateDrPlan
in interfaceDisasterRecoveryAsync
- 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.
-
updateDrPlanExecution
public Future<UpdateDrPlanExecutionResponse> updateDrPlanExecution(UpdateDrPlanExecutionRequest request, AsyncHandler<UpdateDrPlanExecutionRequest,UpdateDrPlanExecutionResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Update the DR plan execution identified by drPlanExecutionId.- Specified by:
updateDrPlanExecution
in interfaceDisasterRecoveryAsync
- 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.
-
updateDrProtectionGroup
public Future<UpdateDrProtectionGroupResponse> updateDrProtectionGroup(UpdateDrProtectionGroupRequest request, AsyncHandler<UpdateDrProtectionGroupRequest,UpdateDrProtectionGroupResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Update the DR protection group identified by drProtectionGroupId.- Specified by:
updateDrProtectionGroup
in interfaceDisasterRecoveryAsync
- 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.
-
updateDrProtectionGroupRole
public Future<UpdateDrProtectionGroupRoleResponse> updateDrProtectionGroupRole(UpdateDrProtectionGroupRoleRequest request, AsyncHandler<UpdateDrProtectionGroupRoleRequest,UpdateDrProtectionGroupRoleResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Update the role of the DR protection group identified by drProtectionGroupId.- Specified by:
updateDrProtectionGroupRole
in interfaceDisasterRecoveryAsync
- 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.
-
verifyDrPlan
public Future<VerifyDrPlanResponse> verifyDrPlan(VerifyDrPlanRequest request, AsyncHandler<VerifyDrPlanRequest,VerifyDrPlanResponse> handler)
Description copied from interface:DisasterRecoveryAsync
Verify DR Plan identified by drPlanId.- Specified by:
verifyDrPlan
in interfaceDisasterRecoveryAsync
- 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)
-
-