Interface GoldenGate
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
GoldenGateClient
@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.
-
-
Method Summary
-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
Method Detail
-
refreshClient
void refreshClient()
Rebuilds the client from scratch.Useful to refresh certificates.
-
setEndpoint
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).- Parameters:
endpoint
- The endpoint of the service.
-
getEndpoint
String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
-
setRegion
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.- Parameters:
region
- The region of the service.
-
setRegion
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 callsetEndpoint
.- Parameters:
regionId
- The public region ID.
-
useRealmSpecificEndpointTemplate
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”
- Parameters:
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint template
-
addConnectionLock
AddConnectionLockResponse addConnectionLock(AddConnectionLockRequest request)
Adds a lock to a Connection resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/AddConnectionLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddConnectionLock API.
-
addDeploymentBackupLock
AddDeploymentBackupLockResponse addDeploymentBackupLock(AddDeploymentBackupLockRequest request)
Adds a lock to a DeploymentBackup resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/AddDeploymentBackupLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddDeploymentBackupLock API.
-
addDeploymentLocalPeer
AddDeploymentLocalPeerResponse addDeploymentLocalPeer(AddDeploymentLocalPeerRequest request)
Adds a new local peer to the deployment, this will add the given placement to deployment placement attribute.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/AddDeploymentLocalPeerExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddDeploymentLocalPeer API.
-
addDeploymentLock
AddDeploymentLockResponse addDeploymentLock(AddDeploymentLockRequest request)
Adds a lock to a Deployment resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/AddDeploymentLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddDeploymentLock API.
-
cancelDeploymentBackup
CancelDeploymentBackupResponse cancelDeploymentBackup(CancelDeploymentBackupRequest request)
Cancels a Deployment Backup creation process.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/CancelDeploymentBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelDeploymentBackup API.
-
cancelDeploymentUpgrade
CancelDeploymentUpgradeResponse cancelDeploymentUpgrade(CancelDeploymentUpgradeRequest request)
Cancels a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/CancelDeploymentUpgradeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelDeploymentUpgrade API.
-
cancelSnoozeDeploymentUpgrade
CancelSnoozeDeploymentUpgradeResponse cancelSnoozeDeploymentUpgrade(CancelSnoozeDeploymentUpgradeRequest request)
Cancel snooze of a DeploymentUpgrade.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/CancelSnoozeDeploymentUpgradeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelSnoozeDeploymentUpgrade API.
-
changeConnectionCompartment
ChangeConnectionCompartmentResponse changeConnectionCompartment(ChangeConnectionCompartmentRequest request)
Moves the Connection 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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ChangeConnectionCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeConnectionCompartment API.
-
changeDatabaseRegistrationCompartment
ChangeDatabaseRegistrationCompartmentResponse changeDatabaseRegistrationCompartment(ChangeDatabaseRegistrationCompartmentRequest request)
Note: Deprecated.Use the /connections API instead. 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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ChangeDatabaseRegistrationCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeDatabaseRegistrationCompartment API.
-
changeDeploymentBackupCompartment
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ChangeDeploymentBackupCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeDeploymentBackupCompartment API.
-
changeDeploymentCompartment
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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ChangeDeploymentCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeDeploymentCompartment API.
-
changePipelineCompartment
ChangePipelineCompartmentResponse changePipelineCompartment(ChangePipelineCompartmentRequest request)
Moves the Pipeline 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.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ChangePipelineCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangePipelineCompartment API.
-
collectDeploymentDiagnostic
CollectDeploymentDiagnosticResponse collectDeploymentDiagnostic(CollectDeploymentDiagnosticRequest request)
Collects the diagnostic of a Deployment.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/CollectDeploymentDiagnosticExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CollectDeploymentDiagnostic API.
-
collectPipelineDiagnostic
CollectPipelineDiagnosticResponse collectPipelineDiagnostic(CollectPipelineDiagnosticRequest request)
Collects diagnostics for the pipeline- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/CollectPipelineDiagnosticExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CollectPipelineDiagnostic API.
-
copyDeploymentBackup
CopyDeploymentBackupResponse copyDeploymentBackup(CopyDeploymentBackupRequest request)
Creates a copy of a Deployment Backup.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/CopyDeploymentBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CopyDeploymentBackup API.
-
createCertificate
CreateCertificateResponse createCertificate(CreateCertificateRequest request)
Creates a new certificate to truststore.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/CreateCertificateExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateCertificate API.
-
createConnection
CreateConnectionResponse createConnection(CreateConnectionRequest request)
Creates a new Connection.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/CreateConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateConnection API.
-
createConnectionAssignment
CreateConnectionAssignmentResponse createConnectionAssignment(CreateConnectionAssignmentRequest request)
Creates a new Connection Assignment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/CreateConnectionAssignmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateConnectionAssignment API.
-
createDatabaseRegistration
CreateDatabaseRegistrationResponse createDatabaseRegistration(CreateDatabaseRegistrationRequest request)
Note: Deprecated.Use the /connections API instead. Creates a new DatabaseRegistration.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/CreateDatabaseRegistrationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDatabaseRegistration API.
-
createDeployment
CreateDeploymentResponse createDeployment(CreateDeploymentRequest request)
Creates a new Deployment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/CreateDeploymentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDeployment API.
-
createDeploymentBackup
CreateDeploymentBackupResponse createDeploymentBackup(CreateDeploymentBackupRequest request)
Creates a new DeploymentBackup.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/CreateDeploymentBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDeploymentBackup API.
-
createPipeline
CreatePipelineResponse createPipeline(CreatePipelineRequest request)
Creates a new Pipeline.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/CreatePipelineExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreatePipeline API.
-
deleteCertificate
DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest request)
Deletes the certificate from truststore.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/DeleteCertificateExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteCertificate API.
-
deleteConnection
DeleteConnectionResponse deleteConnection(DeleteConnectionRequest request)
Deletes a Connection.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/DeleteConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteConnection API.
-
deleteConnectionAssignment
DeleteConnectionAssignmentResponse deleteConnectionAssignment(DeleteConnectionAssignmentRequest request)
Deletes a Connection Assignment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/DeleteConnectionAssignmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteConnectionAssignment API.
-
deleteDatabaseRegistration
DeleteDatabaseRegistrationResponse deleteDatabaseRegistration(DeleteDatabaseRegistrationRequest request)
Note: Deprecated.Use the /connections API instead. Deletes a DatabaseRegistration.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/DeleteDatabaseRegistrationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDatabaseRegistration API.
-
deleteDeployment
DeleteDeploymentResponse deleteDeployment(DeleteDeploymentRequest request)
Deletes the Deployment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/DeleteDeploymentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDeployment API.
-
deleteDeploymentBackup
DeleteDeploymentBackupResponse deleteDeploymentBackup(DeleteDeploymentBackupRequest request)
Deletes a DeploymentBackup.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/DeleteDeploymentBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDeploymentBackup API.
-
deletePipeline
DeletePipelineResponse deletePipeline(DeletePipelineRequest request)
Deletes a Pipeline.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/DeletePipelineExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeletePipeline API.
-
deploymentWalletExists
DeploymentWalletExistsResponse deploymentWalletExists(DeploymentWalletExistsRequest request)
Checks if a wallet is already present in the deployment.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/DeploymentWalletExistsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeploymentWalletExists API.
-
exportDeploymentWallet
ExportDeploymentWalletResponse exportDeploymentWallet(ExportDeploymentWalletRequest request)
Export the OGG wallet from the deployment to OCI vault.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ExportDeploymentWalletExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ExportDeploymentWallet API.
-
generateLibraryUrl
GenerateLibraryUrlResponse generateLibraryUrl(GenerateLibraryUrlRequest request)
Generates a Pre-Authenticated Request Object URL to a DB2 for z/OS library that needs to be uploaded to your DB2 for z/OS server in order to establish GoldenGate connections to it.For licensing reasons, the URL is accessible for 10 minutes only.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/GenerateLibraryUrlExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GenerateLibraryUrl API.
-
getCertificate
GetCertificateResponse getCertificate(GetCertificateRequest request)
Retrieves a Certificate.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/GetCertificateExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCertificate API.
-
getConnection
GetConnectionResponse getConnection(GetConnectionRequest request)
Retrieves a Connection.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/GetConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetConnection API.
-
getConnectionAssignment
GetConnectionAssignmentResponse getConnectionAssignment(GetConnectionAssignmentRequest request)
Retrieves a Connection Assignment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/GetConnectionAssignmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetConnectionAssignment API.
-
getDatabaseRegistration
GetDatabaseRegistrationResponse getDatabaseRegistration(GetDatabaseRegistrationRequest request)
Note: Deprecated.Use the /connections API instead. Retrieves a DatabaseRegistration.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/GetDatabaseRegistrationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDatabaseRegistration API.
-
getDeployment
GetDeploymentResponse getDeployment(GetDeploymentRequest request)
Retrieves a deployment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/GetDeploymentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDeployment API.
-
getDeploymentBackup
GetDeploymentBackupResponse getDeploymentBackup(GetDeploymentBackupRequest request)
Retrieves a DeploymentBackup.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/GetDeploymentBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDeploymentBackup API.
-
getDeploymentUpgrade
GetDeploymentUpgradeResponse getDeploymentUpgrade(GetDeploymentUpgradeRequest request)
Retrieves a deployment upgrade.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/GetDeploymentUpgradeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDeploymentUpgrade API.
-
getPipeline
GetPipelineResponse getPipeline(GetPipelineRequest request)
Retrieves a Pipeline details.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/GetPipelineExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPipeline API.
-
getWorkRequest
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Retrieve the WorkRequest identified by the given OCID.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.
-
importDeploymentWallet
ImportDeploymentWalletResponse importDeploymentWallet(ImportDeploymentWalletRequest request)
Imports an OGG wallet from the OCI Vault to the Deployment.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ImportDeploymentWalletExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ImportDeploymentWallet API.
-
listCertificates
ListCertificatesResponse listCertificates(ListCertificatesRequest request)
Returns a list of certificates from truststore.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListCertificatesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCertificates API.
-
listConnectionAssignments
ListConnectionAssignmentsResponse listConnectionAssignments(ListConnectionAssignmentsRequest request)
Lists the Connection Assignments in the compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListConnectionAssignmentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListConnectionAssignments API.
-
listConnections
ListConnectionsResponse listConnections(ListConnectionsRequest request)
Lists the Connections in the compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListConnectionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListConnections API.
-
listDatabaseRegistrations
ListDatabaseRegistrationsResponse listDatabaseRegistrations(ListDatabaseRegistrationsRequest request)
Note: Deprecated.Use the /connections API instead. Lists the DatabaseRegistrations in the compartment.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListDatabaseRegistrationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDatabaseRegistrations API.
-
listDeploymentBackups
ListDeploymentBackupsResponse listDeploymentBackups(ListDeploymentBackupsRequest request)
Lists the Backups in a compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListDeploymentBackupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDeploymentBackups API.
-
listDeploymentEnvironments
ListDeploymentEnvironmentsResponse listDeploymentEnvironments(ListDeploymentEnvironmentsRequest request)
Returns an array of DeploymentEnvironmentDescriptor- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListDeploymentEnvironmentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDeploymentEnvironments API.
-
listDeploymentPeers
ListDeploymentPeersResponse listDeploymentPeers(ListDeploymentPeersRequest request)
Lists the local and remote peers in a deployment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListDeploymentPeersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDeploymentPeers API.
-
listDeploymentTypes
ListDeploymentTypesResponse listDeploymentTypes(ListDeploymentTypesRequest request)
Returns an array of DeploymentTypeDescriptor- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListDeploymentTypesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDeploymentTypes API.
-
listDeploymentUpgrades
ListDeploymentUpgradesResponse listDeploymentUpgrades(ListDeploymentUpgradesRequest request)
Lists the Deployment Upgrades in a compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListDeploymentUpgradesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDeploymentUpgrades API.
-
listDeploymentVersions
ListDeploymentVersionsResponse listDeploymentVersions(ListDeploymentVersionsRequest request)
Returns the list of available deployment versions.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListDeploymentVersionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDeploymentVersions API.
-
listDeploymentWalletsOperations
ListDeploymentWalletsOperationsResponse listDeploymentWalletsOperations(ListDeploymentWalletsOperationsRequest request)
Lists the wallets export/import operations to/from a deployment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListDeploymentWalletsOperationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDeploymentWalletsOperations API.
-
listDeployments
ListDeploymentsResponse listDeployments(ListDeploymentsRequest request)
Lists the Deployments in a compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListDeploymentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDeployments API.
-
listMessages
ListMessagesResponse listMessages(ListMessagesRequest request)
Lists the DeploymentMessages for a deployment.The sorting order is not important. By default first will be Upgrade message, next Exception message and then Storage Utilization message.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListMessagesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListMessages API.
-
listPipelineInitializationSteps
ListPipelineInitializationStepsResponse listPipelineInitializationSteps(ListPipelineInitializationStepsRequest request)
Retrieves a Pipeline recipe steps and its progress details.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListPipelineInitializationStepsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPipelineInitializationSteps API.
-
listPipelineRunningProcesses
ListPipelineRunningProcessesResponse listPipelineRunningProcesses(ListPipelineRunningProcessesRequest request)
Retrieves a Pipeline’s running replication process’s status like Capture/Apply.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListPipelineRunningProcessesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPipelineRunningProcesses API.
-
listPipelineSchemaTables
ListPipelineSchemaTablesResponse listPipelineSchemaTables(ListPipelineSchemaTablesRequest request)
Returns an array of tables under the given schemas of the pipeline for given source and target schemas passed as query params.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListPipelineSchemaTablesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPipelineSchemaTables API.
-
listPipelineSchemas
ListPipelineSchemasResponse listPipelineSchemas(ListPipelineSchemasRequest request)
Returns an array of schemas based on mapping rules for a pipeline.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListPipelineSchemasExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPipelineSchemas API.
-
listPipelines
ListPipelinesResponse listPipelines(ListPipelinesRequest request)
Lists the Pipelines in the compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListPipelinesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPipelines API.
-
listRecipes
ListRecipesResponse listRecipes(ListRecipesRequest request)
Returns an array of Recipe Summary.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListRecipesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListRecipes API.
-
listTrailFiles
ListTrailFilesResponse listTrailFiles(ListTrailFilesRequest request)
Lists the TrailFiles for a deployment.Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListTrailFilesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTrailFiles API.
-
listTrailSequences
ListTrailSequencesResponse listTrailSequences(ListTrailSequencesRequest request)
Lists the Trail Sequences for a TrailFile in a given deployment.Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListTrailSequencesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTrailSequences API.
-
listWorkRequestErrors
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Lists work request errors.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestErrors API.
-
listWorkRequestLogs
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Lists work request logs.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestLogs API.
-
listWorkRequests
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in the compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.
-
refreshConnection
RefreshConnectionResponse refreshConnection(RefreshConnectionRequest request)
Refresh the external Connection attributes.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/RefreshConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RefreshConnection API.
-
removeConnectionLock
RemoveConnectionLockResponse removeConnectionLock(RemoveConnectionLockRequest request)
Removes a lock from a Connection resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/RemoveConnectionLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveConnectionLock API.
-
removeDeploymentBackupLock
RemoveDeploymentBackupLockResponse removeDeploymentBackupLock(RemoveDeploymentBackupLockRequest request)
Removes a lock from a DeploymentBackup resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/RemoveDeploymentBackupLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveDeploymentBackupLock API.
-
removeDeploymentLocalPeer
RemoveDeploymentLocalPeerResponse removeDeploymentLocalPeer(RemoveDeploymentLocalPeerRequest request)
Removes a local peer of the deployment, this will remove the given placement entry from the deployment placement attribute.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/RemoveDeploymentLocalPeerExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveDeploymentLocalPeer API.
-
removeDeploymentLock
RemoveDeploymentLockResponse removeDeploymentLock(RemoveDeploymentLockRequest request)
Removes a lock from a Deployment resource.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/RemoveDeploymentLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveDeploymentLock API.
-
rescheduleDeploymentUpgrade
RescheduleDeploymentUpgradeResponse rescheduleDeploymentUpgrade(RescheduleDeploymentUpgradeRequest request)
Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/RescheduleDeploymentUpgradeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RescheduleDeploymentUpgrade API.
-
restoreDeployment
RestoreDeploymentResponse restoreDeployment(RestoreDeploymentRequest request)
Restores a Deployment from a Deployment Backup created from the same Deployment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/RestoreDeploymentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RestoreDeployment API.
-
rollbackDeploymentUpgrade
RollbackDeploymentUpgradeResponse rollbackDeploymentUpgrade(RollbackDeploymentUpgradeRequest request)
Rollback a deployment to it’s previous version.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/RollbackDeploymentUpgradeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RollbackDeploymentUpgrade API.
-
snoozeDeploymentUpgrade
SnoozeDeploymentUpgradeResponse snoozeDeploymentUpgrade(SnoozeDeploymentUpgradeRequest request)
Snooze a DeploymentUpgrade.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/SnoozeDeploymentUpgradeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SnoozeDeploymentUpgrade API.
-
startDeployment
StartDeploymentResponse startDeployment(StartDeploymentRequest request)
Starts a Deployment.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/StartDeploymentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StartDeployment API.
-
startPipeline
StartPipelineResponse startPipeline(StartPipelineRequest request)
Starts the pipeline for data replication.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/StartPipelineExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StartPipeline API.
-
stopDeployment
StopDeploymentResponse stopDeployment(StopDeploymentRequest request)
Stops a Deployment.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/StopDeploymentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StopDeployment API.
-
stopPipeline
StopPipelineResponse stopPipeline(StopPipelineRequest request)
Stops the pipeline for data replication.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/StopPipelineExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StopPipeline API.
-
switchoverDeploymentPeer
SwitchoverDeploymentPeerResponse switchoverDeploymentPeer(SwitchoverDeploymentPeerRequest request)
Switchover to the selected standby peer, which can be a local placement or a standby deployment in different region.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/SwitchoverDeploymentPeerExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SwitchoverDeploymentPeer API.
-
testConnectionAssignment
TestConnectionAssignmentResponse testConnectionAssignment(TestConnectionAssignmentRequest request)
Tests the connectivity between given GoldenGate deployment and one of the associated database / service.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/TestConnectionAssignmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use TestConnectionAssignment API.
-
testPipelineConnection
TestPipelineConnectionResponse testPipelineConnection(TestPipelineConnectionRequest request)
Tests pipeline connections against pipeline to verify the connectivity.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/TestPipelineConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use TestPipelineConnection API.
-
updateConnection
UpdateConnectionResponse updateConnection(UpdateConnectionRequest request)
Updates the Connection.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/UpdateConnectionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateConnection API.
-
updateDatabaseRegistration
UpdateDatabaseRegistrationResponse updateDatabaseRegistration(UpdateDatabaseRegistrationRequest request)
Note: Deprecated.Use the /connections API instead. Updates the DatabaseRegistration.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/UpdateDatabaseRegistrationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDatabaseRegistration API.
-
updateDeployment
UpdateDeploymentResponse updateDeployment(UpdateDeploymentRequest request)
Modifies a Deployment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/UpdateDeploymentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDeployment API.
-
updateDeploymentBackup
UpdateDeploymentBackupResponse updateDeploymentBackup(UpdateDeploymentBackupRequest request)
Modifies a Deployment Backup.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/UpdateDeploymentBackupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDeploymentBackup API.
-
updatePipeline
UpdatePipelineResponse updatePipeline(UpdatePipelineRequest request)
Updates the Pipeline.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/UpdatePipelineExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdatePipeline API.
-
upgradeDeployment
UpgradeDeploymentResponse upgradeDeployment(UpgradeDeploymentRequest request)
Upgrade a Deployment.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/UpgradeDeploymentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpgradeDeployment API.
-
upgradeDeploymentUpgrade
UpgradeDeploymentUpgradeResponse upgradeDeploymentUpgrade(UpgradeDeploymentUpgradeRequest request)
Upgrade a deployment.When provided, If-Match is checked against ETag values of the resource.
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/goldengate/UpgradeDeploymentUpgradeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpgradeDeploymentUpgrade API.
-
getWaiters
GoldenGateWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.- Returns:
- The service waiters.
-
getPaginators
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.- Returns:
- The service paginators.
-
-