@Generated(value="OracleSDKGenerator", comments="API Version: 20210216") public interface DatabaseRecovery extends AutoCloseable
Use Oracle Database Autonomous Recovery Service API to manage Protected Databases. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
Modifier and Type | Method and Description |
---|---|
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.
|
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 |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
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 |
refreshClient()
Rebuilds the client from scratch.
|
ScheduleProtectedDatabaseDeletionResponse |
scheduleProtectedDatabaseDeletion(ScheduleProtectedDatabaseDeletionRequest request)
Defines a preferred schedule to delete a protected database after you terminate the source
database.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
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’).
|
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 realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.
|
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
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.
region
- The region of the service.void setRegion(String regionId)
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
.
regionId
- The public region ID.void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateCancelProtectedDatabaseDeletionResponse cancelProtectedDatabaseDeletion(CancelProtectedDatabaseDeletionRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CancelProtectedDatabaseDeletion API.
ChangeProtectedDatabaseCompartmentResponse changeProtectedDatabaseCompartment(ChangeProtectedDatabaseCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeProtectedDatabaseCompartment API.
ChangeProtectedDatabaseSubscriptionResponse changeProtectedDatabaseSubscription(ChangeProtectedDatabaseSubscriptionRequest request)
Associates the protected database with a new cloud service environment, such as Microsoft Azure.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeProtectedDatabaseSubscription API.
ChangeProtectionPolicyCompartmentResponse changeProtectionPolicyCompartment(ChangeProtectionPolicyCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeProtectionPolicyCompartment API.
ChangeRecoveryServiceSubnetCompartmentResponse changeRecoveryServiceSubnetCompartment(ChangeRecoveryServiceSubnetCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeRecoveryServiceSubnetCompartment API.
CreateProtectedDatabaseResponse createProtectedDatabase(CreateProtectedDatabaseRequest request)
Creates a new Protected Database.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateProtectedDatabase API.
CreateProtectionPolicyResponse createProtectionPolicy(CreateProtectionPolicyRequest request)
Creates a new Protection Policy.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateProtectionPolicy API.
CreateRecoveryServiceSubnetResponse createRecoveryServiceSubnet(CreateRecoveryServiceSubnetRequest request)
Creates a new Recovery Service Subnet.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateRecoveryServiceSubnet API.
DeleteProtectedDatabaseResponse deleteProtectedDatabase(DeleteProtectedDatabaseRequest request)
Deletes a protected database based on the specified protected database ID.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteProtectedDatabase API.
DeleteProtectionPolicyResponse deleteProtectionPolicy(DeleteProtectionPolicyRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteProtectionPolicy API.
DeleteRecoveryServiceSubnetResponse deleteRecoveryServiceSubnet(DeleteRecoveryServiceSubnetRequest request)
Deletes a specified recovery service subnet.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteRecoveryServiceSubnet API.
FetchProtectedDatabaseConfigurationResponse fetchProtectedDatabaseConfiguration(FetchProtectedDatabaseConfigurationRequest request)
Downloads the network service configuration file ‘tnsnames.ora’ for a specified protected database. Applies to user-defined recovery systems only.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use FetchProtectedDatabaseConfiguration API.
GetProtectedDatabaseResponse getProtectedDatabase(GetProtectedDatabaseRequest request)
Gets information about a specified protected database.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetProtectedDatabase API.
GetProtectionPolicyResponse getProtectionPolicy(GetProtectionPolicyRequest request)
Gets information about a specified protection policy.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetProtectionPolicy API.
GetRecoveryServiceSubnetResponse getRecoveryServiceSubnet(GetRecoveryServiceSubnetRequest request)
Gets information about a specified recovery service subnet.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetRecoveryServiceSubnet API.
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Gets the status of the work request based on the specified ID
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetWorkRequest API.
ListProtectedDatabasesResponse listProtectedDatabases(ListProtectedDatabasesRequest request)
Lists the protected databases based on the specified parameters.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListProtectedDatabases API.
ListProtectionPoliciesResponse listProtectionPolicies(ListProtectionPoliciesRequest request)
Gets a list of protection policies based on the specified parameters.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListProtectionPolicies API.
ListRecoveryServiceSubnetsResponse listRecoveryServiceSubnets(ListRecoveryServiceSubnetsRequest request)
Returns a list of Recovery Service Subnets.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListRecoveryServiceSubnets API.
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Return a (paginated) list of errors for a given work request.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWorkRequestErrors API.
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Return a (paginated) list of logs for a given work request.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWorkRequestLogs API.
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListWorkRequests API.
ScheduleProtectedDatabaseDeletionResponse scheduleProtectedDatabaseDeletion(ScheduleProtectedDatabaseDeletionRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ScheduleProtectedDatabaseDeletion API.
UpdateProtectedDatabaseResponse updateProtectedDatabase(UpdateProtectedDatabaseRequest request)
Updates the Protected Database
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateProtectedDatabase API.
UpdateProtectionPolicyResponse updateProtectionPolicy(UpdateProtectionPolicyRequest request)
Updates the specified protection policy.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateProtectionPolicy API.
UpdateRecoveryServiceSubnetResponse updateRecoveryServiceSubnet(UpdateRecoveryServiceSubnetRequest request)
Updates the specified recovery service subnet.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateRecoveryServiceSubnet API.
DatabaseRecoveryWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
DatabaseRecoveryPaginators getPaginators()
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.
Copyright © 2016–2024. All rights reserved.