@Generated(value="OracleSDKGenerator", comments="API Version: 20210216") public class DatabaseRecoveryClient extends BaseSyncClient implements DatabaseRecovery
Modifier and Type | Class and Description |
---|---|
static class |
DatabaseRecoveryClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for DatabaseRecovery.
|
Constructor and 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. |
Modifier and Type | Method and Description |
---|---|
static DatabaseRecoveryClient.Builder |
builder()
Create a builder for this client.
|
ChangeProtectedDatabaseCompartmentResponse |
changeProtectedDatabaseCompartment(ChangeProtectedDatabaseCompartmentRequest request)
Moves a protected database resource from the existing compartment to the specified
compartment.
|
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.
|
protected ClientConfigurator |
getDefaultConfigurator() |
String |
getEndpoint() |
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 . |
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.
|
clientCall
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for DatabaseRecovery.
@Deprecated public DatabaseRecoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseRecoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public DatabaseRecoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseRecoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public DatabaseRecoveryClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see DatabaseRecoveryClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public DatabaseRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
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
@Deprecated public DatabaseRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
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
@Deprecated public DatabaseRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see 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)
@Deprecated public DatabaseRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see 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
@Deprecated public DatabaseRecoveryClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
builder
instead.Create a new client instance.
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
public static DatabaseRecoveryClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
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.
setRegion
in interface DatabaseRecovery
region
- The region of the service.public void setRegion(String regionId)
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
.
setRegion
in interface DatabaseRecovery
regionId
- The public region ID.public ChangeProtectedDatabaseCompartmentResponse changeProtectedDatabaseCompartment(ChangeProtectedDatabaseCompartmentRequest request)
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.
changeProtectedDatabaseCompartment
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic ChangeProtectionPolicyCompartmentResponse changeProtectionPolicyCompartment(ChangeProtectionPolicyCompartmentRequest request)
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.
changeProtectionPolicyCompartment
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic ChangeRecoveryServiceSubnetCompartmentResponse changeRecoveryServiceSubnetCompartment(ChangeRecoveryServiceSubnetCompartmentRequest request)
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.
changeRecoveryServiceSubnetCompartment
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic CreateProtectedDatabaseResponse createProtectedDatabase(CreateProtectedDatabaseRequest request)
DatabaseRecovery
Creates a new Protected Database.
createProtectedDatabase
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic CreateProtectionPolicyResponse createProtectionPolicy(CreateProtectionPolicyRequest request)
DatabaseRecovery
Creates a new Protection Policy.
createProtectionPolicy
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic CreateRecoveryServiceSubnetResponse createRecoveryServiceSubnet(CreateRecoveryServiceSubnetRequest request)
DatabaseRecovery
Creates a new Recovery Service Subnet.
createRecoveryServiceSubnet
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic DeleteProtectedDatabaseResponse deleteProtectedDatabase(DeleteProtectedDatabaseRequest request)
DatabaseRecovery
Deletes a protected database based on the specified protected database ID.
deleteProtectedDatabase
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic DeleteProtectionPolicyResponse deleteProtectionPolicy(DeleteProtectionPolicyRequest request)
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.
deleteProtectionPolicy
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic DeleteRecoveryServiceSubnetResponse deleteRecoveryServiceSubnet(DeleteRecoveryServiceSubnetRequest request)
DatabaseRecovery
Deletes a specified recovery service subnet.
deleteRecoveryServiceSubnet
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic FetchProtectedDatabaseConfigurationResponse fetchProtectedDatabaseConfiguration(FetchProtectedDatabaseConfigurationRequest request)
DatabaseRecovery
Downloads the network service configuration file ‘tnsnames.ora’ for a specified protected database. Applies to user-defined recovery systems only.
fetchProtectedDatabaseConfiguration
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic GetProtectedDatabaseResponse getProtectedDatabase(GetProtectedDatabaseRequest request)
DatabaseRecovery
Gets information about a specified protected database.
getProtectedDatabase
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic GetProtectionPolicyResponse getProtectionPolicy(GetProtectionPolicyRequest request)
DatabaseRecovery
Gets information about a specified protection policy.
getProtectionPolicy
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic GetRecoveryServiceSubnetResponse getRecoveryServiceSubnet(GetRecoveryServiceSubnetRequest request)
DatabaseRecovery
Gets information about a specified recovery service subnet.
getRecoveryServiceSubnet
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
DatabaseRecovery
Gets the status of the work request based on the specified ID
getWorkRequest
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic ListProtectedDatabasesResponse listProtectedDatabases(ListProtectedDatabasesRequest request)
DatabaseRecovery
Lists the protected databases based on the specified parameters.
listProtectedDatabases
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic ListProtectionPoliciesResponse listProtectionPolicies(ListProtectionPoliciesRequest request)
DatabaseRecovery
Gets a list of protection policies based on the specified parameters.
listProtectionPolicies
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic ListRecoveryServiceSubnetsResponse listRecoveryServiceSubnets(ListRecoveryServiceSubnetsRequest request)
DatabaseRecovery
Returns a list of Recovery Service Subnets.
listRecoveryServiceSubnets
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
DatabaseRecovery
Return a (paginated) list of errors for a given work request.
listWorkRequestErrors
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
DatabaseRecovery
Return a (paginated) list of logs for a given work request.
listWorkRequestLogs
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
DatabaseRecovery
Lists the work requests in a compartment.
listWorkRequests
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic UpdateProtectedDatabaseResponse updateProtectedDatabase(UpdateProtectedDatabaseRequest request)
DatabaseRecovery
Updates the Protected Database
updateProtectedDatabase
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic UpdateProtectionPolicyResponse updateProtectionPolicy(UpdateProtectionPolicyRequest request)
DatabaseRecovery
Updates the specified protection policy.
updateProtectionPolicy
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic UpdateRecoveryServiceSubnetResponse updateRecoveryServiceSubnet(UpdateRecoveryServiceSubnetRequest request)
DatabaseRecovery
Updates the specified recovery service subnet.
updateRecoveryServiceSubnet
in interface DatabaseRecovery
request
- The request object containing the details to sendpublic DatabaseRecoveryWaiters getWaiters()
DatabaseRecovery
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface DatabaseRecovery
public DatabaseRecoveryPaginators getPaginators()
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.
getPaginators
in interface DatabaseRecovery
protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
Copyright © 2016–2023. All rights reserved.