@Generated(value="OracleSDKGenerator", comments="API Version: 20200407") public interface GoldenGate extends AutoCloseable
Use the Oracle Cloud Infrastructure GoldenGate APIs to perform data replication operations.
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
closevoid 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.CancelDeploymentBackupResponse cancelDeploymentBackup(CancelDeploymentBackupRequest request)
Cancels a Deployment Backup creation process.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 CancelDeploymentBackup API.
ChangeDatabaseRegistrationCompartmentResponse changeDatabaseRegistrationCompartment(ChangeDatabaseRegistrationCompartmentRequest request)
Moves the DatabaseRegistration into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 ChangeDatabaseRegistrationCompartment API.
ChangeDeploymentBackupCompartmentResponse changeDeploymentBackupCompartment(ChangeDeploymentBackupCompartmentRequest request)
Moves a DeploymentBackup into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 ChangeDeploymentBackupCompartment API.
ChangeDeploymentCompartmentResponse changeDeploymentCompartment(ChangeDeploymentCompartmentRequest request)
Moves the Deployment into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 ChangeDeploymentCompartment API.
CreateDatabaseRegistrationResponse createDatabaseRegistration(CreateDatabaseRegistrationRequest request)
Creates a new DatabaseRegistration.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 CreateDatabaseRegistration API.
CreateDeploymentResponse createDeployment(CreateDeploymentRequest request)
Creates a new Deployment.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 CreateDeployment API.
CreateDeploymentBackupResponse createDeploymentBackup(CreateDeploymentBackupRequest request)
Creates a new DeploymentBackup.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 CreateDeploymentBackup API.
DeleteDatabaseRegistrationResponse deleteDatabaseRegistration(DeleteDatabaseRegistrationRequest request)
Deletes a DatabaseRegistration.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 DeleteDatabaseRegistration API.
DeleteDeploymentResponse deleteDeployment(DeleteDeploymentRequest request)
Deletes the Deployment.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 DeleteDeployment API.
DeleteDeploymentBackupResponse deleteDeploymentBackup(DeleteDeploymentBackupRequest request)
Deletes a DeploymentBackup.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 DeleteDeploymentBackup API.
GetDatabaseRegistrationResponse getDatabaseRegistration(GetDatabaseRegistrationRequest request)
Retrieves a DatabaseRegistration.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 GetDatabaseRegistration API.
GetDeploymentResponse getDeployment(GetDeploymentRequest request)
Retrieves a deployment.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 GetDeployment API.
GetDeploymentBackupResponse getDeploymentBackup(GetDeploymentBackupRequest request)
Retrieves a DeploymentBackup.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 GetDeploymentBackup API.
GetDeploymentUpgradeResponse getDeploymentUpgrade(GetDeploymentUpgradeRequest request)
Retrieves a deployment upgrade.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 GetDeploymentUpgrade API.
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Retrieve the WorkRequest identified by the given OCID.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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.
ListDatabaseRegistrationsResponse listDatabaseRegistrations(ListDatabaseRegistrationsRequest request)
Lists the DatabaseRegistrations in the compartment.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 ListDatabaseRegistrations API.
ListDeploymentBackupsResponse listDeploymentBackups(ListDeploymentBackupsRequest request)
Lists the Backups in a compartment.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 ListDeploymentBackups API.
ListDeploymentUpgradesResponse listDeploymentUpgrades(ListDeploymentUpgradesRequest request)
Lists the Deployment Upgrades in a compartment.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 ListDeploymentUpgrades API.
ListDeploymentsResponse listDeployments(ListDeploymentsRequest request)
Lists the Deployments in a compartment.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 ListDeployments API.
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Lists work request errors.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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)
Lists work request logs.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 the compartment.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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.
RestoreDeploymentResponse restoreDeployment(RestoreDeploymentRequest request)
Restores a Deployment from a Deployment Backup created from the same Deployment.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 RestoreDeployment API.
StartDeploymentResponse startDeployment(StartDeploymentRequest request)
Starts a Deployment. 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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 StartDeployment API.
StopDeploymentResponse stopDeployment(StopDeploymentRequest request)
Stops a Deployment. 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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 StopDeployment API.
UpdateDatabaseRegistrationResponse updateDatabaseRegistration(UpdateDatabaseRegistrationRequest request)
Updates the DatabaseRegistration.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 UpdateDatabaseRegistration API.
UpdateDeploymentResponse updateDeployment(UpdateDeploymentRequest request)
Modifies a Deployment.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 UpdateDeployment API.
UpdateDeploymentBackupResponse updateDeploymentBackup(UpdateDeploymentBackupRequest request)
Modifies a Deployment Backup.
request - The request object containing the details to sendBmcException - when an error occurs.
This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 UpdateDeploymentBackup API.
UpgradeDeploymentResponse upgradeDeployment(UpgradeDeploymentRequest request)
Upgrade a Deployment. 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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it.
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 UpgradeDeployment API.
GoldenGateWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
GoldenGatePaginators 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–2022. All rights reserved.