Class DatabaseRecoveryAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.recovery.DatabaseRecoveryAsyncClient
-
- All Implemented Interfaces:
DatabaseRecoveryAsync
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20210216") public class DatabaseRecoveryAsyncClient extends BaseAsyncClient implements DatabaseRecoveryAsync
Async client implementation for DatabaseRecovery 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
DatabaseRecoveryAsyncClient.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 DatabaseRecovery.
-
Constructor Summary
Constructors Constructor Description DatabaseRecoveryAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.DatabaseRecoveryAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.DatabaseRecoveryAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DatabaseRecoveryAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DatabaseRecoveryAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.DatabaseRecoveryAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.DatabaseRecoveryAsyncClient(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.recovery.DatabaseRecoveryAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DatabaseRecoveryAsyncClient
@Deprecated public DatabaseRecoveryAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDatabaseRecoveryAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
DatabaseRecoveryAsyncClient
@Deprecated public DatabaseRecoveryAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDatabaseRecoveryAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
DatabaseRecoveryAsyncClient
@Deprecated public DatabaseRecoveryAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDatabaseRecoveryAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DatabaseRecoveryAsyncClient
@Deprecated public DatabaseRecoveryAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDatabaseRecoveryAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
DatabaseRecoveryAsyncClient
@Deprecated public DatabaseRecoveryAsyncClient(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 (seeDatabaseRecoveryAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
DatabaseRecoveryAsyncClient
@Deprecated public DatabaseRecoveryAsyncClient(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 (seeDatabaseRecoveryAsyncClient.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)
-
DatabaseRecoveryAsyncClient
@Deprecated public DatabaseRecoveryAsyncClient(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 (seeDatabaseRecoveryAsyncClient.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 DatabaseRecoveryAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:DatabaseRecoveryAsync
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 interfaceDatabaseRecoveryAsync
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DatabaseRecoveryAsync
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 interfaceDatabaseRecoveryAsync
- Parameters:
regionId
- The public region ID.
-
cancelProtectedDatabaseDeletion
public Future<CancelProtectedDatabaseDeletionResponse> cancelProtectedDatabaseDeletion(CancelProtectedDatabaseDeletionRequest request, AsyncHandler<CancelProtectedDatabaseDeletionRequest,CancelProtectedDatabaseDeletionResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Cancels the scheduled deletion of a protected database, and returns the protected database to an ACTIVE state.You can cancel the deletion only if the protected database is in the DELETE SCHEDULED state.
- Specified by:
cancelProtectedDatabaseDeletion
in interfaceDatabaseRecoveryAsync
- 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.
-
changeProtectedDatabaseCompartment
public Future<ChangeProtectedDatabaseCompartmentResponse> changeProtectedDatabaseCompartment(ChangeProtectedDatabaseCompartmentRequest request, AsyncHandler<ChangeProtectedDatabaseCompartmentRequest,ChangeProtectedDatabaseCompartmentResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Moves a protected database resource from the existing compartment to the specified compartment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeProtectedDatabaseCompartment
in interfaceDatabaseRecoveryAsync
- 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.
-
changeProtectedDatabaseSubscription
public Future<ChangeProtectedDatabaseSubscriptionResponse> changeProtectedDatabaseSubscription(ChangeProtectedDatabaseSubscriptionRequest request, AsyncHandler<ChangeProtectedDatabaseSubscriptionRequest,ChangeProtectedDatabaseSubscriptionResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Associates the protected database with a new cloud service environment, such as Microsoft Azure.- Specified by:
changeProtectedDatabaseSubscription
in interfaceDatabaseRecoveryAsync
- 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.
-
changeProtectionPolicyCompartment
public Future<ChangeProtectionPolicyCompartmentResponse> changeProtectionPolicyCompartment(ChangeProtectionPolicyCompartmentRequest request, AsyncHandler<ChangeProtectionPolicyCompartmentRequest,ChangeProtectionPolicyCompartmentResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Moves a protection policy resource from the existing compartment to the specified compartment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeProtectionPolicyCompartment
in interfaceDatabaseRecoveryAsync
- 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.
-
changeRecoveryServiceSubnetCompartment
public Future<ChangeRecoveryServiceSubnetCompartmentResponse> changeRecoveryServiceSubnetCompartment(ChangeRecoveryServiceSubnetCompartmentRequest request, AsyncHandler<ChangeRecoveryServiceSubnetCompartmentRequest,ChangeRecoveryServiceSubnetCompartmentResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Moves a recovery service subnet resource from the existing compartment to the specified compartment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeRecoveryServiceSubnetCompartment
in interfaceDatabaseRecoveryAsync
- 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.
-
createProtectedDatabase
public Future<CreateProtectedDatabaseResponse> createProtectedDatabase(CreateProtectedDatabaseRequest request, AsyncHandler<CreateProtectedDatabaseRequest,CreateProtectedDatabaseResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Creates a new Protected Database.- Specified by:
createProtectedDatabase
in interfaceDatabaseRecoveryAsync
- 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.
-
createProtectionPolicy
public Future<CreateProtectionPolicyResponse> createProtectionPolicy(CreateProtectionPolicyRequest request, AsyncHandler<CreateProtectionPolicyRequest,CreateProtectionPolicyResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Creates a new Protection Policy.- Specified by:
createProtectionPolicy
in interfaceDatabaseRecoveryAsync
- 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.
-
createRecoveryServiceSubnet
public Future<CreateRecoveryServiceSubnetResponse> createRecoveryServiceSubnet(CreateRecoveryServiceSubnetRequest request, AsyncHandler<CreateRecoveryServiceSubnetRequest,CreateRecoveryServiceSubnetResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Creates a new Recovery Service Subnet.- Specified by:
createRecoveryServiceSubnet
in interfaceDatabaseRecoveryAsync
- 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.
-
deleteProtectedDatabase
public Future<DeleteProtectedDatabaseResponse> deleteProtectedDatabase(DeleteProtectedDatabaseRequest request, AsyncHandler<DeleteProtectedDatabaseRequest,DeleteProtectedDatabaseResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Deletes a protected database based on the specified protected database ID.- Specified by:
deleteProtectedDatabase
in interfaceDatabaseRecoveryAsync
- 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.
-
deleteProtectionPolicy
public Future<DeleteProtectionPolicyResponse> deleteProtectionPolicy(DeleteProtectionPolicyRequest request, AsyncHandler<DeleteProtectionPolicyRequest,DeleteProtectionPolicyResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Deletes a specified protection policy.You can delete custom policies only. Deleting a Oracle predefined policies will result in status code 405 Method Not Allowed.
- Specified by:
deleteProtectionPolicy
in interfaceDatabaseRecoveryAsync
- 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.
-
deleteRecoveryServiceSubnet
public Future<DeleteRecoveryServiceSubnetResponse> deleteRecoveryServiceSubnet(DeleteRecoveryServiceSubnetRequest request, AsyncHandler<DeleteRecoveryServiceSubnetRequest,DeleteRecoveryServiceSubnetResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Deletes a specified recovery service subnet.- Specified by:
deleteRecoveryServiceSubnet
in interfaceDatabaseRecoveryAsync
- 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.
-
fetchProtectedDatabaseConfiguration
public Future<FetchProtectedDatabaseConfigurationResponse> fetchProtectedDatabaseConfiguration(FetchProtectedDatabaseConfigurationRequest request, AsyncHandler<FetchProtectedDatabaseConfigurationRequest,FetchProtectedDatabaseConfigurationResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Downloads the network service configuration file ‘tnsnames.ora’ for a specified protected database.Applies to user-defined recovery systems only.
- Specified by:
fetchProtectedDatabaseConfiguration
in interfaceDatabaseRecoveryAsync
- 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.
-
getProtectedDatabase
public Future<GetProtectedDatabaseResponse> getProtectedDatabase(GetProtectedDatabaseRequest request, AsyncHandler<GetProtectedDatabaseRequest,GetProtectedDatabaseResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Gets information about a specified protected database.- Specified by:
getProtectedDatabase
in interfaceDatabaseRecoveryAsync
- 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.
-
getProtectionPolicy
public Future<GetProtectionPolicyResponse> getProtectionPolicy(GetProtectionPolicyRequest request, AsyncHandler<GetProtectionPolicyRequest,GetProtectionPolicyResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Gets information about a specified protection policy.- Specified by:
getProtectionPolicy
in interfaceDatabaseRecoveryAsync
- 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.
-
getRecoveryServiceSubnet
public Future<GetRecoveryServiceSubnetResponse> getRecoveryServiceSubnet(GetRecoveryServiceSubnetRequest request, AsyncHandler<GetRecoveryServiceSubnetRequest,GetRecoveryServiceSubnetResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Gets information about a specified recovery service subnet.- Specified by:
getRecoveryServiceSubnet
in interfaceDatabaseRecoveryAsync
- 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:DatabaseRecoveryAsync
Gets the status of the work request based on the specified ID- Specified by:
getWorkRequest
in interfaceDatabaseRecoveryAsync
- 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.
-
listProtectedDatabases
public Future<ListProtectedDatabasesResponse> listProtectedDatabases(ListProtectedDatabasesRequest request, AsyncHandler<ListProtectedDatabasesRequest,ListProtectedDatabasesResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Lists the protected databases based on the specified parameters.- Specified by:
listProtectedDatabases
in interfaceDatabaseRecoveryAsync
- 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.
-
listProtectionPolicies
public Future<ListProtectionPoliciesResponse> listProtectionPolicies(ListProtectionPoliciesRequest request, AsyncHandler<ListProtectionPoliciesRequest,ListProtectionPoliciesResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Gets a list of protection policies based on the specified parameters.- Specified by:
listProtectionPolicies
in interfaceDatabaseRecoveryAsync
- 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.
-
listRecoveryServiceSubnets
public Future<ListRecoveryServiceSubnetsResponse> listRecoveryServiceSubnets(ListRecoveryServiceSubnetsRequest request, AsyncHandler<ListRecoveryServiceSubnetsRequest,ListRecoveryServiceSubnetsResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Returns a list of Recovery Service Subnets.- Specified by:
listRecoveryServiceSubnets
in interfaceDatabaseRecoveryAsync
- 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:DatabaseRecoveryAsync
Return a (paginated) list of errors for a given work request.- Specified by:
listWorkRequestErrors
in interfaceDatabaseRecoveryAsync
- 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:DatabaseRecoveryAsync
Return a (paginated) list of logs for a given work request.- Specified by:
listWorkRequestLogs
in interfaceDatabaseRecoveryAsync
- 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:DatabaseRecoveryAsync
Lists the work requests in a compartment.- Specified by:
listWorkRequests
in interfaceDatabaseRecoveryAsync
- 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.
-
scheduleProtectedDatabaseDeletion
public Future<ScheduleProtectedDatabaseDeletionResponse> scheduleProtectedDatabaseDeletion(ScheduleProtectedDatabaseDeletionRequest request, AsyncHandler<ScheduleProtectedDatabaseDeletionRequest,ScheduleProtectedDatabaseDeletionResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Defines a preferred schedule to delete a protected database after you terminate the source database.The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated. The alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the policy-defined backup retention period expires.
- Specified by:
scheduleProtectedDatabaseDeletion
in interfaceDatabaseRecoveryAsync
- 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.
-
updateProtectedDatabase
public Future<UpdateProtectedDatabaseResponse> updateProtectedDatabase(UpdateProtectedDatabaseRequest request, AsyncHandler<UpdateProtectedDatabaseRequest,UpdateProtectedDatabaseResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Updates the Protected Database- Specified by:
updateProtectedDatabase
in interfaceDatabaseRecoveryAsync
- 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.
-
updateProtectionPolicy
public Future<UpdateProtectionPolicyResponse> updateProtectionPolicy(UpdateProtectionPolicyRequest request, AsyncHandler<UpdateProtectionPolicyRequest,UpdateProtectionPolicyResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Updates the specified protection policy.- Specified by:
updateProtectionPolicy
in interfaceDatabaseRecoveryAsync
- 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.
-
updateRecoveryServiceSubnet
public Future<UpdateRecoveryServiceSubnetResponse> updateRecoveryServiceSubnet(UpdateRecoveryServiceSubnetRequest request, AsyncHandler<UpdateRecoveryServiceSubnetRequest,UpdateRecoveryServiceSubnetResponse> handler)
Description copied from interface:DatabaseRecoveryAsync
Updates the specified recovery service subnet.- Specified by:
updateRecoveryServiceSubnet
in interfaceDatabaseRecoveryAsync
- 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)
-
-