Package com.oracle.bmc.recovery

Class DatabaseRecoveryClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.recovery.DatabaseRecoveryClient

All Implemented Interfaces:

DatabaseRecovery, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210216")
public class DatabaseRecoveryClient
extends BaseSyncClient
implements DatabaseRecovery

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DatabaseRecoveryClient.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
DatabaseRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
DatabaseRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
DatabaseRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
DatabaseRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
DatabaseRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
DatabaseRecoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
DatabaseRecoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
DatabaseRecoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static DatabaseRecoveryClient.Builder	builder()	Create a builder for this client.
CancelProtectedDatabaseDeletionResponse	cancelProtectedDatabaseDeletion(CancelProtectedDatabaseDeletionRequest request)	Cancels the scheduled deletion of a protected database, and returns the protected database to an ACTIVE state.
ChangeProtectedDatabaseCompartmentResponse	changeProtectedDatabaseCompartment(ChangeProtectedDatabaseCompartmentRequest request)	Moves a protected database resource from the existing compartment to the specified compartment.
ChangeProtectedDatabaseSubscriptionResponse	changeProtectedDatabaseSubscription(ChangeProtectedDatabaseSubscriptionRequest request)	Associates the protected database with a new cloud service environment, such as Microsoft Azure.
ChangeProtectionPolicyCompartmentResponse	changeProtectionPolicyCompartment(ChangeProtectionPolicyCompartmentRequest request)	Moves a protection policy resource from the existing compartment to the specified compartment.
ChangeRecoveryServiceSubnetCompartmentResponse	changeRecoveryServiceSubnetCompartment(ChangeRecoveryServiceSubnetCompartmentRequest request)	Moves a recovery service subnet resource from the existing compartment to the specified compartment.
void	close()
CreateProtectedDatabaseResponse	createProtectedDatabase(CreateProtectedDatabaseRequest request)	Creates a new Protected Database.
CreateProtectionPolicyResponse	createProtectionPolicy(CreateProtectionPolicyRequest request)	Creates a new Protection Policy.
CreateRecoveryServiceSubnetResponse	createRecoveryServiceSubnet(CreateRecoveryServiceSubnetRequest request)	Creates a new Recovery Service Subnet.
DeleteProtectedDatabaseResponse	deleteProtectedDatabase(DeleteProtectedDatabaseRequest request)	Deletes a protected database based on the specified protected database ID.
DeleteProtectionPolicyResponse	deleteProtectionPolicy(DeleteProtectionPolicyRequest request)	Deletes a specified protection policy.
DeleteRecoveryServiceSubnetResponse	deleteRecoveryServiceSubnet(DeleteRecoveryServiceSubnetRequest request)	Deletes a specified recovery service subnet.
FetchProtectedDatabaseConfigurationResponse	fetchProtectedDatabaseConfiguration(FetchProtectedDatabaseConfigurationRequest request)	Downloads the network service configuration file ‘tnsnames.ora’ for a specified protected database.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
DatabaseRecoveryPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetProtectedDatabaseResponse	getProtectedDatabase(GetProtectedDatabaseRequest request)	Gets information about a specified protected database.
GetProtectionPolicyResponse	getProtectionPolicy(GetProtectionPolicyRequest request)	Gets information about a specified protection policy.
GetRecoveryServiceSubnetResponse	getRecoveryServiceSubnet(GetRecoveryServiceSubnetRequest request)	Gets information about a specified recovery service subnet.
DatabaseRecoveryWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request)	Gets the status of the work request based on the specified ID
ListProtectedDatabasesResponse	listProtectedDatabases(ListProtectedDatabasesRequest request)	Lists the protected databases based on the specified parameters.
ListProtectionPoliciesResponse	listProtectionPolicies(ListProtectionPoliciesRequest request)	Gets a list of protection policies based on the specified parameters.
ListRecoveryServiceSubnetsResponse	listRecoveryServiceSubnets(ListRecoveryServiceSubnetsRequest request)	Returns a list of Recovery Service Subnets.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request)	Return a (paginated) list of errors for a given work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request)	Return a (paginated) list of logs for a given work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request)	Lists the work requests in a compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient()	Rebuild the backing HttpClient.
ScheduleProtectedDatabaseDeletionResponse	scheduleProtectedDatabaseDeletion(ScheduleProtectedDatabaseDeletionRequest request)	Defines a preferred schedule to delete a protected database after you terminate the source database.
void	setEndpoint(String endpoint)
void	setRegion(Region region)	Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId)	Sets the region to call (ex, ‘us-phoenix-1’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdateProtectedDatabaseResponse	updateProtectedDatabase(UpdateProtectedDatabaseRequest request)	Updates the Protected Database
UpdateProtectionPolicyResponse	updateProtectionPolicy(UpdateProtectionPolicyRequest request)	Updates the specified protection policy.
UpdateRecoveryServiceSubnetResponse	updateRecoveryServiceSubnet(UpdateRecoveryServiceSubnetRequest request)	Updates the specified recovery service subnet.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

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.DatabaseRecovery

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for DatabaseRecovery.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

DatabaseRecoveryClient

@Deprecated
public DatabaseRecoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DatabaseRecoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

DatabaseRecoveryClient

@Deprecated
public DatabaseRecoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                              ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DatabaseRecoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

DatabaseRecoveryClient

@Deprecated
public DatabaseRecoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                              ClientConfiguration configuration,
                              ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DatabaseRecoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

DatabaseRecoveryClient

@Deprecated
public DatabaseRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                              ClientConfiguration configuration,
                              ClientConfigurator clientConfigurator,
                              RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DatabaseRecoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DatabaseRecoveryClient

@Deprecated
public DatabaseRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                              ClientConfiguration configuration,
                              ClientConfigurator clientConfigurator,
                              RequestSignerFactory defaultRequestSignerFactory,
                              List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DatabaseRecoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DatabaseRecoveryClient

@Deprecated
public DatabaseRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                              ClientConfiguration configuration,
                              ClientConfigurator clientConfigurator,
                              RequestSignerFactory defaultRequestSignerFactory,
                              List<ClientConfigurator> additionalClientConfigurators,
                              String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DatabaseRecoveryClient.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)

DatabaseRecoveryClient

@Deprecated
public DatabaseRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                              ClientConfiguration configuration,
                              ClientConfigurator clientConfigurator,
                              RequestSignerFactory defaultRequestSignerFactory,
                              Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                              List<ClientConfigurator> additionalClientConfigurators,
                              String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DatabaseRecoveryClient.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

DatabaseRecoveryClient

@Deprecated
public DatabaseRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                              ClientConfiguration configuration,
                              ClientConfigurator clientConfigurator,
                              RequestSignerFactory defaultRequestSignerFactory,
                              Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                              List<ClientConfigurator> additionalClientConfigurators,
                              String endpoint,
                              ExecutorService executorService)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DatabaseRecoveryClient.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

executorService - DatabaseRecoveryClient.Builder.executorService

Method Detail

builder

public static DatabaseRecoveryClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DatabaseRecovery

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 interface DatabaseRecovery

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DatabaseRecovery

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.

Specified by:

setRegion in interface DatabaseRecovery

Parameters:

regionId - The public region ID.

cancelProtectedDatabaseDeletion

public CancelProtectedDatabaseDeletionResponse cancelProtectedDatabaseDeletion(CancelProtectedDatabaseDeletionRequest request)

Description copied from interface: DatabaseRecovery

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 interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeProtectedDatabaseCompartment

public ChangeProtectedDatabaseCompartmentResponse changeProtectedDatabaseCompartment(ChangeProtectedDatabaseCompartmentRequest request)

Description copied from interface: DatabaseRecovery

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 interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeProtectedDatabaseSubscription

public ChangeProtectedDatabaseSubscriptionResponse changeProtectedDatabaseSubscription(ChangeProtectedDatabaseSubscriptionRequest request)

Description copied from interface: DatabaseRecovery

Associates the protected database with a new cloud service environment, such as Microsoft Azure.

Specified by:

changeProtectedDatabaseSubscription in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeProtectionPolicyCompartment

public ChangeProtectionPolicyCompartmentResponse changeProtectionPolicyCompartment(ChangeProtectionPolicyCompartmentRequest request)

Description copied from interface: DatabaseRecovery

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 interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeRecoveryServiceSubnetCompartment

public ChangeRecoveryServiceSubnetCompartmentResponse changeRecoveryServiceSubnetCompartment(ChangeRecoveryServiceSubnetCompartmentRequest request)

Description copied from interface: DatabaseRecovery

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 interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createProtectedDatabase

public CreateProtectedDatabaseResponse createProtectedDatabase(CreateProtectedDatabaseRequest request)

Description copied from interface: DatabaseRecovery

Creates a new Protected Database.

Specified by:

createProtectedDatabase in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createProtectionPolicy

public CreateProtectionPolicyResponse createProtectionPolicy(CreateProtectionPolicyRequest request)

Description copied from interface: DatabaseRecovery

Creates a new Protection Policy.

Specified by:

createProtectionPolicy in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createRecoveryServiceSubnet

public CreateRecoveryServiceSubnetResponse createRecoveryServiceSubnet(CreateRecoveryServiceSubnetRequest request)

Description copied from interface: DatabaseRecovery

Creates a new Recovery Service Subnet.

Specified by:

createRecoveryServiceSubnet in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteProtectedDatabase

public DeleteProtectedDatabaseResponse deleteProtectedDatabase(DeleteProtectedDatabaseRequest request)

Description copied from interface: DatabaseRecovery

Deletes a protected database based on the specified protected database ID.

Specified by:

deleteProtectedDatabase in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteProtectionPolicy

public DeleteProtectionPolicyResponse deleteProtectionPolicy(DeleteProtectionPolicyRequest request)

Description copied from interface: DatabaseRecovery

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 interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteRecoveryServiceSubnet

public DeleteRecoveryServiceSubnetResponse deleteRecoveryServiceSubnet(DeleteRecoveryServiceSubnetRequest request)

Description copied from interface: DatabaseRecovery

Deletes a specified recovery service subnet.

Specified by:

deleteRecoveryServiceSubnet in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

fetchProtectedDatabaseConfiguration

public FetchProtectedDatabaseConfigurationResponse fetchProtectedDatabaseConfiguration(FetchProtectedDatabaseConfigurationRequest request)

Description copied from interface: DatabaseRecovery

Downloads the network service configuration file ‘tnsnames.ora’ for a specified protected database.

Applies to user-defined recovery systems only.

Specified by:

fetchProtectedDatabaseConfiguration in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getProtectedDatabase

public GetProtectedDatabaseResponse getProtectedDatabase(GetProtectedDatabaseRequest request)

Description copied from interface: DatabaseRecovery

Gets information about a specified protected database.

Specified by:

getProtectedDatabase in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getProtectionPolicy

public GetProtectionPolicyResponse getProtectionPolicy(GetProtectionPolicyRequest request)

Description copied from interface: DatabaseRecovery

Gets information about a specified protection policy.

Specified by:

getProtectionPolicy in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getRecoveryServiceSubnet

public GetRecoveryServiceSubnetResponse getRecoveryServiceSubnet(GetRecoveryServiceSubnetRequest request)

Description copied from interface: DatabaseRecovery

Gets information about a specified recovery service subnet.

Specified by:

getRecoveryServiceSubnet in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: DatabaseRecovery

Gets the status of the work request based on the specified ID

Specified by:

getWorkRequest in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listProtectedDatabases

public ListProtectedDatabasesResponse listProtectedDatabases(ListProtectedDatabasesRequest request)

Description copied from interface: DatabaseRecovery

Lists the protected databases based on the specified parameters.

Specified by:

listProtectedDatabases in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listProtectionPolicies

public ListProtectionPoliciesResponse listProtectionPolicies(ListProtectionPoliciesRequest request)

Description copied from interface: DatabaseRecovery

Gets a list of protection policies based on the specified parameters.

Specified by:

listProtectionPolicies in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listRecoveryServiceSubnets

public ListRecoveryServiceSubnetsResponse listRecoveryServiceSubnets(ListRecoveryServiceSubnetsRequest request)

Description copied from interface: DatabaseRecovery

Returns a list of Recovery Service Subnets.

Specified by:

listRecoveryServiceSubnets in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: DatabaseRecovery

Return a (paginated) list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: DatabaseRecovery

Return a (paginated) list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: DatabaseRecovery

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

scheduleProtectedDatabaseDeletion

public ScheduleProtectedDatabaseDeletionResponse scheduleProtectedDatabaseDeletion(ScheduleProtectedDatabaseDeletionRequest request)

Description copied from interface: DatabaseRecovery

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 interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateProtectedDatabase

public UpdateProtectedDatabaseResponse updateProtectedDatabase(UpdateProtectedDatabaseRequest request)

Description copied from interface: DatabaseRecovery

Updates the Protected Database

Specified by:

updateProtectedDatabase in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateProtectionPolicy

public UpdateProtectionPolicyResponse updateProtectionPolicy(UpdateProtectionPolicyRequest request)

Description copied from interface: DatabaseRecovery

Updates the specified protection policy.

Specified by:

updateProtectionPolicy in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateRecoveryServiceSubnet

public UpdateRecoveryServiceSubnetResponse updateRecoveryServiceSubnet(UpdateRecoveryServiceSubnetRequest request)

Description copied from interface: DatabaseRecovery

Updates the specified recovery service subnet.

Specified by:

updateRecoveryServiceSubnet in interface DatabaseRecovery

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public DatabaseRecoveryWaiters getWaiters()

Description copied from interface: DatabaseRecovery

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface DatabaseRecovery

Returns:

The service waiters.

getPaginators

public DatabaseRecoveryPaginators getPaginators()

Description copied from interface: DatabaseRecovery

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface DatabaseRecovery

Returns:

The service paginators.

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 use

requiredParametersMap - 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 backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()