GoldenGateClient¶

class oci.golden_gate.GoldenGateClient(config, **kwargs)¶

Use the Oracle Cloud Infrastructure GoldenGate APIs to perform data replication operations.

Methods

`__init__`(config, **kwargs)	Creates a new service client
`add_connection_lock`(connection_id, …)	Adds a lock to a Connection resource.
`add_deployment_backup_lock`(…)	Adds a lock to a DeploymentBackup resource.
`add_deployment_lock`(deployment_id, …)	Adds a lock to a Deployment resource.
`cancel_deployment_backup`(…)	Cancels a Deployment Backup creation process.
`cancel_deployment_upgrade`(…)	Cancels a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state.
`cancel_snooze_deployment_upgrade`(…)	Cancel snooze of a DeploymentUpgrade.
`change_connection_compartment`(connection_id, …)	Moves the Connection into a different compartment within the same tenancy.
`change_database_registration_compartment`(…)	Note: Deprecated.
`change_deployment_backup_compartment`(…)	Moves a DeploymentBackup into a different compartment within the same tenancy.
`change_deployment_compartment`(deployment_id, …)	Moves the Deployment into a different compartment within the same tenancy.
`collect_deployment_diagnostic`(deployment_id, …)	Collects the diagnostic of a Deployment.
`copy_deployment_backup`(deployment_backup_id, …)	Creates a copy of a Deployment Backup.
`create_certificate`(…)	Creates a new certificate to truststore.
`create_connection`(create_connection_details, …)	Creates a new Connection.
`create_connection_assignment`(…)	Creates a new Connection Assignment.
`create_database_registration`(…)	Note: Deprecated.
`create_deployment`(create_deployment_details, …)	Creates a new Deployment.
`create_deployment_backup`(…)	Creates a new DeploymentBackup.
`delete_certificate`(deployment_id, …)	Deletes the certificate from truststore.
`delete_connection`(connection_id, **kwargs)	Deletes a Connection.
`delete_connection_assignment`(…)	Deletes a Connection Assignment.
`delete_database_registration`(…)	Note: Deprecated.
`delete_deployment`(deployment_id, **kwargs)	Deletes the Deployment.
`delete_deployment_backup`(…)	Deletes a DeploymentBackup.
`deployment_wallet_exists`(deployment_id, …)	Checks if a wallet is already present in the deployment.
`export_deployment_wallet`(deployment_id, …)	Export the OGG wallet from the deployment to OCI vault.
`generate_library_url`(deployment_id, …)	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.
`get_certificate`(deployment_id, …)	Retrieves a Certificate.
`get_connection`(connection_id, **kwargs)	Retrieves a Connection.
`get_connection_assignment`(…)	Retrieves a Connection Assignment.
`get_database_registration`(…)	Note: Deprecated.
`get_deployment`(deployment_id, **kwargs)	Retrieves a deployment.
`get_deployment_backup`(deployment_backup_id, …)	Retrieves a DeploymentBackup.
`get_deployment_upgrade`(…)	Retrieves a deployment upgrade.
`get_work_request`(work_request_id, **kwargs)	Retrieve the WorkRequest identified by the given OCID.
`import_deployment_wallet`(deployment_id, …)	Imports an OGG wallet from the OCI Vault to the Deployment.
`list_certificates`(deployment_id, **kwargs)	Returns a list of certificates from truststore.
`list_connection_assignments`(compartment_id, …)	Lists the Connection Assignments in the compartment.
`list_connections`(compartment_id, **kwargs)	Lists the Connections in the compartment.
`list_database_registrations`(compartment_id, …)	Note: Deprecated.
`list_deployment_backups`(compartment_id, **kwargs)	Lists the Backups in a compartment.
`list_deployment_environments`(compartment_id, …)	Returns an array of DeploymentEnvironmentDescriptor
`list_deployment_types`(compartment_id, **kwargs)	Returns an array of DeploymentTypeDescriptor
`list_deployment_upgrades`(compartment_id, …)	Lists the Deployment Upgrades in a compartment.
`list_deployment_versions`(compartment_id, …)	Returns the list of available deployment versions.
`list_deployment_wallets_operations`(…)	Lists the wallets export/import operations to/from a deployment.
`list_deployments`(compartment_id, **kwargs)	Lists the Deployments in a compartment.
`list_messages`(deployment_id, **kwargs)	Lists the DeploymentMessages for a deployment.
`list_trail_files`(deployment_id, **kwargs)	Lists the TrailFiles for a deployment.
`list_trail_sequences`(deployment_id, …)	Lists the Trail Sequences for a TrailFile in a given deployment.
`list_work_request_errors`(work_request_id, …)	Lists work request errors.
`list_work_request_logs`(work_request_id, **kwargs)	Lists work request logs.
`list_work_requests`(compartment_id, **kwargs)	Lists the work requests in the compartment.
`refresh_connection`(connection_id, …)	Refresh the external Connection attributes.
`remove_connection_lock`(connection_id, …)	Removes a lock from a Connection resource.
`remove_deployment_backup_lock`(…)	Removes a lock from a DeploymentBackup resource.
`remove_deployment_lock`(deployment_id, …)	Removes a lock from a Deployment resource.
`reschedule_deployment_upgrade`(…)	Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state.
`restore_deployment`(deployment_backup_id, …)	Restores a Deployment from a Deployment Backup created from the same Deployment.
`rollback_deployment_upgrade`(…)	Rollback a deployment to it’s previous version.
`snooze_deployment_upgrade`(…)	Snooze a DeploymentUpgrade.
`start_deployment`(deployment_id, …)	Starts a Deployment.
`stop_deployment`(deployment_id, …)	Stops a Deployment.
`test_connection_assignment`(…)	Tests the connectivity between given GoldenGate deployment and one of the associated database / service.
`update_connection`(connection_id, …)	Updates the Connection.
`update_database_registration`(…)	Note: Deprecated.
`update_deployment`(deployment_id, …)	Modifies a Deployment.
`update_deployment_backup`(…)	Modifies a Deployment Backup.
`upgrade_deployment`(deployment_id, …)	Upgrade a Deployment.
`upgrade_deployment_upgrade`(…)	Upgrade a deployment.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

add_connection_lock(connection_id, add_resource_lock_details, **kwargs)¶

Adds a lock to a Connection resource.

Parameters:	connection_id (str) – (required) The OCID of a Connection. add_resource_lock_details (oci.golden_gate.models.AddResourceLockDetails) – (required) AddResourceLockDetails body parameter opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Connection`
Return type:	`Response`
Example:

Click here to see an example of how to use add_connection_lock API.

add_deployment_backup_lock(deployment_backup_id, add_resource_lock_details, **kwargs)¶

Adds a lock to a DeploymentBackup resource.

Parameters:	deployment_backup_id (str) – (required) A unique DeploymentBackup identifier. add_resource_lock_details (oci.golden_gate.models.AddResourceLockDetails) – (required) AddResourceLockDetails body parameter opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DeploymentBackup`
Return type:	`Response`
Example:

Click here to see an example of how to use add_deployment_backup_lock API.

add_deployment_lock(deployment_id, add_resource_lock_details, **kwargs)¶

Adds a lock to a Deployment resource.

Parameters:	deployment_id (str) – (required) A unique Deployment identifier. add_resource_lock_details (oci.golden_gate.models.AddResourceLockDetails) – (required) AddResourceLockDetails body parameter opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Deployment`
Return type:	`Response`
Example:

Click here to see an example of how to use add_deployment_lock API.

cancel_deployment_backup(deployment_backup_id, cancel_deployment_backup_details, **kwargs)¶

Cancels a Deployment Backup creation process.

Parameters:	deployment_backup_id (str) – (required) A unique DeploymentBackup identifier. cancel_deployment_backup_details (oci.golden_gate.models.CancelDeploymentBackupDetails) – (required) A placeholder for any additional metadata to describe the deployment backup cancel. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use cancel_deployment_backup API.

cancel_deployment_upgrade(deployment_upgrade_id, cancel_deployment_upgrade_details, **kwargs)¶

Cancels a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.

Parameters:	deployment_upgrade_id (str) – (required) A unique Deployment Upgrade identifier. cancel_deployment_upgrade_details (oci.golden_gate.models.CancelDeploymentUpgradeDetails) – (required) A placeholder for any additional metadata to describe the cancel snooze of deployment upgrade. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DeploymentUpgrade`
Return type:	`Response`
Example:

Click here to see an example of how to use cancel_deployment_upgrade API.

cancel_snooze_deployment_upgrade(deployment_upgrade_id, cancel_snooze_deployment_upgrade_details, **kwargs)¶

Cancel snooze of a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.

Parameters:	deployment_upgrade_id (str) – (required) A unique Deployment Upgrade identifier. cancel_snooze_deployment_upgrade_details (oci.golden_gate.models.CancelSnoozeDeploymentUpgradeDetails) – (required) A placeholder for any additional metadata to describe the cancel snooze of deployment upgrade. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use cancel_snooze_deployment_upgrade API.

change_connection_compartment(connection_id, change_connection_compartment_details, **kwargs)¶

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:	connection_id (str) – (required) The OCID of a Connection. change_connection_compartment_details (oci.golden_gate.models.ChangeConnectionCompartmentDetails) – (required) Properties to change the compartment of a Connection. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_connection_compartment API.

change_database_registration_compartment(database_registration_id, change_database_registration_compartment_details, **kwargs)¶

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:	database_registration_id (str) – (required) A unique DatabaseRegistration identifier. change_database_registration_compartment_details (oci.golden_gate.models.ChangeDatabaseRegistrationCompartmentDetails) – (required) Properties to change the compartment of a DatabaseRegistration. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_database_registration_compartment API.

change_deployment_backup_compartment(deployment_backup_id, change_deployment_backup_compartment_details, **kwargs)¶

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:	deployment_backup_id (str) – (required) A unique DeploymentBackup identifier. change_deployment_backup_compartment_details (oci.golden_gate.models.ChangeDeploymentBackupCompartmentDetails) – (required) Properties to change the compartment of a DeploymentBackup. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_deployment_backup_compartment API.

change_deployment_compartment(deployment_id, change_deployment_compartment_details, **kwargs)¶

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:	deployment_id (str) – (required) A unique Deployment identifier. change_deployment_compartment_details (oci.golden_gate.models.ChangeDeploymentCompartmentDetails) – (required) Properties to change the compartment of a Deployment. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_deployment_compartment API.

collect_deployment_diagnostic(deployment_id, collect_deployment_diagnostic_details, **kwargs)¶

Collects the diagnostic of a Deployment. When provided, If-Match is checked against ETag values of the resource.

Parameters:	deployment_id (str) – (required) A unique Deployment identifier. collect_deployment_diagnostic_details (oci.golden_gate.models.CollectDeploymentDiagnosticDetails) – (required) Metadata about the deployment diagnostic. This also includes the Object storage information where the diagnostic will be uploaded if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use collect_deployment_diagnostic API.

copy_deployment_backup(deployment_backup_id, copy_deployment_backup_details, **kwargs)¶

Creates a copy of a Deployment Backup.

Parameters:	deployment_backup_id (str) – (required) A unique DeploymentBackup identifier. copy_deployment_backup_details (oci.golden_gate.models.CopyDeploymentBackupDetails) – (required) A placeholder for any additional metadata to describe the copy of a Deployment Backup. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DeploymentBackup`
Return type:	`Response`
Example:

Click here to see an example of how to use copy_deployment_backup API.

create_certificate(create_certificate_details, deployment_id, **kwargs)¶

Creates a new certificate to truststore.

Parameters:	create_certificate_details (oci.golden_gate.models.CreateCertificateDetails) – (required) Specifications to create the certificate to truststore. deployment_id (str) – (required) A unique Deployment identifier. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use create_certificate API.

create_connection(create_connection_details, **kwargs)¶

Creates a new Connection.

Parameters:	create_connection_details (oci.golden_gate.models.CreateConnectionDetails) – (required) Specification of the Connection to create. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Connection`
Return type:	`Response`
Example:

Click here to see an example of how to use create_connection API.

create_connection_assignment(create_connection_assignment_details, **kwargs)¶

Creates a new Connection Assignment.

Parameters:	create_connection_assignment_details (oci.golden_gate.models.CreateConnectionAssignmentDetails) – (required) Specification of the connection assignment to create. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ConnectionAssignment`
Return type:	`Response`
Example:

Click here to see an example of how to use create_connection_assignment API.

create_database_registration(create_database_registration_details, **kwargs)¶

Note: Deprecated. Use the /connections API instead. Creates a new DatabaseRegistration.

Parameters:	create_database_registration_details (oci.golden_gate.models.CreateDatabaseRegistrationDetails) – (required) Specification of the DatabaseRegistration to create. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseRegistration`
Return type:	`Response`
Example:

Click here to see an example of how to use create_database_registration API.

create_deployment(create_deployment_details, **kwargs)¶

Creates a new Deployment.

Parameters:	create_deployment_details (oci.golden_gate.models.CreateDeploymentDetails) – (required) Specifications to create the Deployment. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Deployment`
Return type:	`Response`
Example:

Click here to see an example of how to use create_deployment API.

create_deployment_backup(create_deployment_backup_details, **kwargs)¶

Creates a new DeploymentBackup.

Parameters:	create_deployment_backup_details (oci.golden_gate.models.CreateDeploymentBackupDetails) – (required) Specification of the DeploymentBackup to create. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DeploymentBackup`
Return type:	`Response`
Example:

Click here to see an example of how to use create_deployment_backup API.

delete_certificate(deployment_id, certificate_key, **kwargs)¶

Deletes the certificate from truststore.

Parameters:	deployment_id (str) – (required) A unique Deployment identifier. certificate_key (str) – (required) A unique certificate identifier. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_certificate API.

delete_connection(connection_id, **kwargs)¶

Deletes a Connection.

Parameters:	connection_id (str) – (required) The OCID of a Connection. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_connection API.

delete_connection_assignment(connection_assignment_id, **kwargs)¶

Deletes a Connection Assignment.

Parameters:	connection_assignment_id (str) – (required) The OCID of the Connection Assignment. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_connection_assignment API.

delete_database_registration(database_registration_id, **kwargs)¶

Note: Deprecated. Use the /connections API instead. Deletes a DatabaseRegistration.

Parameters:	database_registration_id (str) – (required) A unique DatabaseRegistration identifier. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_database_registration API.

delete_deployment(deployment_id, **kwargs)¶

Deletes the Deployment.

Parameters:	deployment_id (str) – (required) A unique Deployment identifier. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_deployment API.

delete_deployment_backup(deployment_backup_id, **kwargs)¶

Deletes a DeploymentBackup.

Parameters:	deployment_backup_id (str) – (required) A unique DeploymentBackup identifier. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_deployment_backup API.

deployment_wallet_exists(deployment_id, deployment_wallet_exists_details, **kwargs)¶

Checks if a wallet is already present in the deployment. When provided, If-Match is checked against ETag values of the resource.

Parameters:	deployment_id (str) – (required) A unique Deployment identifier. deployment_wallet_exists_details (oci.golden_gate.models.DeploymentWalletExistsDetails) – (required) A placeholder for any additional metadata to describe the deployment start. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DeploymentWalletExistsResponseDetails`
Return type:	`Response`
Example:

Click here to see an example of how to use deployment_wallet_exists API.

export_deployment_wallet(deployment_id, export_deployment_wallet_details, **kwargs)¶

Export the OGG wallet from the deployment to OCI vault. When provided, If-Match is checked against ETag values of the resource.

Parameters:	deployment_id (str) – (required) A unique Deployment identifier. export_deployment_wallet_details (oci.golden_gate.models.ExportDeploymentWalletDetails) – (required) Metadata to export the OGG wallet from deployment. This also includes the OCI vault information where the wallet will be exported to if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use export_deployment_wallet API.

generate_library_url(deployment_id, generate_library_url_details, **kwargs)¶

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:	deployment_id (str) – (required) A unique Deployment identifier. generate_library_url_details (oci.golden_gate.models.GenerateLibraryUrlDetails) – (required) A placeholder for any additional metadata to describe the request details. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `LibraryUrl`
Return type:	`Response`
Example:

Click here to see an example of how to use generate_library_url API.

get_certificate(deployment_id, certificate_key, **kwargs)¶

Retrieves a Certificate.

Parameters:	deployment_id (str) – (required) A unique Deployment identifier. certificate_key (str) – (required) A unique certificate identifier. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Certificate`
Return type:	`Response`
Example:

Click here to see an example of how to use get_certificate API.

get_connection(connection_id, **kwargs)¶

Retrieves a Connection.

Parameters:	connection_id (str) – (required) The OCID of a Connection. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Connection`
Return type:	`Response`
Example:

Click here to see an example of how to use get_connection API.

get_connection_assignment(connection_assignment_id, **kwargs)¶

Retrieves a Connection Assignment.

Parameters:	connection_assignment_id (str) – (required) The OCID of the Connection Assignment. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ConnectionAssignment`
Return type:	`Response`
Example:

Click here to see an example of how to use get_connection_assignment API.

get_database_registration(database_registration_id, **kwargs)¶

Note: Deprecated. Use the /connections API instead. Retrieves a DatabaseRegistration.

Parameters:	database_registration_id (str) – (required) A unique DatabaseRegistration identifier. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseRegistration`
Return type:	`Response`
Example:

Click here to see an example of how to use get_database_registration API.

get_deployment(deployment_id, **kwargs)¶

Retrieves a deployment.

Parameters:	deployment_id (str) – (required) A unique Deployment identifier. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Deployment`
Return type:	`Response`
Example:

Click here to see an example of how to use get_deployment API.

get_deployment_backup(deployment_backup_id, **kwargs)¶

Retrieves a DeploymentBackup.

Parameters:	deployment_backup_id (str) – (required) A unique DeploymentBackup identifier. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DeploymentBackup`
Return type:	`Response`
Example:

Click here to see an example of how to use get_deployment_backup API.

get_deployment_upgrade(deployment_upgrade_id, **kwargs)¶

Retrieves a deployment upgrade.

Parameters:	deployment_upgrade_id (str) – (required) A unique Deployment Upgrade identifier. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DeploymentUpgrade`
Return type:	`Response`
Example:

Click here to see an example of how to use get_deployment_upgrade API.

get_work_request(work_request_id, **kwargs)¶

Retrieve the WorkRequest identified by the given OCID.

Parameters:	work_request_id (str) – (required) The OCID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkRequest`
Return type:	`Response`
Example:

Click here to see an example of how to use get_work_request API.

import_deployment_wallet(deployment_id, import_deployment_wallet_details, **kwargs)¶

Imports an OGG wallet from the OCI Vault to the Deployment. When provided, If-Match is checked against ETag values of the resource.

Parameters:	deployment_id (str) – (required) A unique Deployment identifier. import_deployment_wallet_details (oci.golden_gate.models.ImportDeploymentWalletDetails) – (required) Metadata to import wallet to deployment. This also includes the OCI Vault information where the wallet will be imported from if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use import_deployment_wallet API.

list_certificates(deployment_id, **kwargs)¶

Returns a list of certificates from truststore.

Parameters:	deployment_id (str) – (required) A unique Deployment identifier. opc_request_id (str) – (optional) The client request ID for tracing. lifecycle_state (str) – (optional) A filter to return only connections having the ‘lifecycleState’ given. Allowed values are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. Default order for ‘timeCreated’ is descending. Default order for ‘displayName’ is ascending. If no value is specified timeCreated is the default. Allowed values are: “timeCreated”, “displayName” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `CertificateCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_certificates API.

list_connection_assignments(compartment_id, **kwargs)¶

Lists the Connection Assignments in the compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. deployment_id (str) – (optional) The OCID of the deployment in which to list resources. connection_id (str) – (optional) The OCID of the connection. name (str) – (optional) The name of the connection in the assignment (aliasName). lifecycle_state (str) – (optional) A filter to return only connection assignments having the ‘lifecycleState’ given. Allowed values are: “CREATING”, “ACTIVE”, “FAILED”, “UPDATING”, “DELETING” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. Default order for ‘timeCreated’ is descending. Default order for ‘displayName’ is ascending. If no value is specified timeCreated is the default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ConnectionAssignmentCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_connection_assignments API.

list_connections(compartment_id, **kwargs)¶

Lists the Connections in the compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. technology_type (list[str]) – (optional) The array of technology types. Allowed values are: “GOLDENGATE”, “GENERIC”, “OCI_AUTONOMOUS_DATABASE”, “OCI_AUTONOMOUS_JSON_DATABASE”, “OCI_CACHE_WITH_REDIS”, “OCI_MYSQL”, “OCI_OBJECT_STORAGE”, “OCI_POSTGRESQL”, “OCI_STREAMING”, “ORACLE_DATABASE”, “ORACLE_EXADATA”, “ORACLE_EXADATA_DATABASE_AT_AZURE”, “ORACLE_NOSQL”, “ORACLE_WEBLOGIC_JMS”, “AMAZON_RDS_ORACLE”, “AMAZON_RDS_SQLSERVER”, “AMAZON_S3”, “AMAZON_AURORA_MYSQL”, “AMAZON_AURORA_POSTGRESQL”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “AMAZON_RDS_MARIADB”, “AMAZON_RDS_MYSQL”, “AMAZON_RDS_POSTGRESQL”, “APACHE_KAFKA”, “AZURE_COSMOS_DB_FOR_MONGODB”, “AZURE_COSMOS_DB_FOR_POSTGRESQL”, “AZURE_DATA_LAKE_STORAGE”, “AZURE_EVENT_HUBS”, “AZURE_MYSQL”, “AZURE_POSTGRESQL”, “AZURE_SQLSERVER_MANAGED_INSTANCE”, “AZURE_SQLSERVER_NON_MANAGED_INSTANCE”, “AZURE_SYNAPSE_ANALYTICS”, “CONFLUENT_KAFKA”, “CONFLUENT_SCHEMA_REGISTRY”, “DB2_ZOS”, “ELASTICSEARCH”, “GOOGLE_BIGQUERY”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_CLOUD_SQL_MYSQL”, “GOOGLE_CLOUD_SQL_POSTGRESQL”, “GOOGLE_CLOUD_SQL_SQLSERVER”, “HDFS”, “MARIADB”, “MICROSOFT_SQLSERVER”, “MONGODB”, “MYSQL_SERVER”, “MYSQL_HEATWAVE_ON_AZURE”, “MYSQL_HEATWAVE_ON_AWS”, “POSTGRESQL_SERVER”, “REDIS”, “SINGLESTOREDB”, “SINGLESTOREDB_CLOUD”, “SNOWFLAKE” connection_type (list[str]) – (optional) The array of connection types. Allowed values are: “GOLDENGATE”, “KAFKA”, “KAFKA_SCHEMA_REGISTRY”, “MYSQL”, “JAVA_MESSAGE_SERVICE”, “MICROSOFT_SQLSERVER”, “OCI_OBJECT_STORAGE”, “ORACLE”, “AZURE_DATA_LAKE_STORAGE”, “POSTGRESQL”, “AZURE_SYNAPSE_ANALYTICS”, “SNOWFLAKE”, “AMAZON_S3”, “HDFS”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY” assigned_deployment_id (str) – (optional) The OCID of the deployment which for the connection must be assigned. assignable_deployment_id (str) – (optional) Filters for compatible connections which can be, but currently not assigned to the deployment specified by its id. assignable_deployment_type (str) – (optional) Filters for connections which can be assigned to the latest version of the specified deployment type. Allowed values are: “OGG”, “DATABASE_ORACLE”, “BIGDATA”, “DATABASE_MICROSOFT_SQLSERVER”, “DATABASE_MYSQL”, “DATABASE_POSTGRESQL”, “DATABASE_DB2ZOS”, “GGSA”, “DATA_TRANSFORMS” lifecycle_state (str) – (optional) A filter to return only connections having the ‘lifecycleState’ given. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED” display_name (str) – (optional) A filter to return only the resources that match the entire ‘displayName’ given. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. Default order for ‘timeCreated’ is descending. Default order for ‘displayName’ is ascending. If no value is specified timeCreated is the default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ConnectionCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_connections API.

list_database_registrations(compartment_id, **kwargs)¶

Note: Deprecated. Use the /connections API instead. Lists the DatabaseRegistrations in the compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. lifecycle_state (str) – (optional) A filter to return only the resources that match the ‘lifecycleState’ given. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, “IN_PROGRESS”, “CANCELING”, “CANCELED”, “SUCCEEDED”, “WAITING” display_name (str) – (optional) A filter to return only the resources that match the entire ‘displayName’ given. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. Default order for ‘timeCreated’ is descending. Default order for ‘displayName’ is ascending. If no value is specified timeCreated is the default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DatabaseRegistrationCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_database_registrations API.

list_deployment_backups(compartment_id, **kwargs)¶

Lists the Backups in a compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. deployment_id (str) – (optional) The OCID of the deployment in which to list resources. lifecycle_state (str) – (optional) A filter to return only the resources that match the ‘lifecycleState’ given. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, “IN_PROGRESS”, “CANCELING”, “CANCELED”, “SUCCEEDED”, “WAITING” display_name (str) – (optional) A filter to return only the resources that match the entire ‘displayName’ given. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. Default order for ‘timeCreated’ is descending. Default order for ‘displayName’ is ascending. If no value is specified timeCreated is the default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DeploymentBackupCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_deployment_backups API.

list_deployment_environments(compartment_id, **kwargs)¶

Returns an array of DeploymentEnvironmentDescriptor

Parameters:	compartment_id (str) – (required) The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. opc_request_id (str) – (optional) The client request ID for tracing. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. Default order for ‘timeCreated’ is descending. Default order for ‘displayName’ is ascending. If no value is specified timeCreated is the default. Allowed values are: “timeCreated”, “displayName” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DeploymentEnvironmentCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_deployment_environments API.

list_deployment_types(compartment_id, **kwargs)¶

Returns an array of DeploymentTypeDescriptor

Parameters:	compartment_id (str) – (required) The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. deployment_type (str) – (optional) The type of deployment, the value determines the exact ‘type’ of the service executed in the deployment. Default value is DATABASE_ORACLE. Allowed values are: “OGG”, “DATABASE_ORACLE”, “BIGDATA”, “DATABASE_MICROSOFT_SQLSERVER”, “DATABASE_MYSQL”, “DATABASE_POSTGRESQL”, “DATABASE_DB2ZOS”, “GGSA”, “DATA_TRANSFORMS” ogg_version (str) – (optional) Allows to query by a specific GoldenGate version. display_name (str) – (optional) A filter to return only the resources that match the entire ‘displayName’ given. opc_request_id (str) – (optional) The client request ID for tracing. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. Default order for ‘timeCreated’ is descending. Default order for ‘displayName’ is ascending. If no value is specified timeCreated is the default. Allowed values are: “timeCreated”, “displayName” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DeploymentTypeCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_deployment_types API.

list_deployment_upgrades(compartment_id, **kwargs)¶

Lists the Deployment Upgrades in a compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. deployment_id (str) – (optional) The OCID of the deployment in which to list resources. lifecycle_state (str) – (optional) A filter to return only the resources that match the ‘lifecycleState’ given. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, “IN_PROGRESS”, “CANCELING”, “CANCELED”, “SUCCEEDED”, “WAITING” display_name (str) – (optional) A filter to return only the resources that match the entire ‘displayName’ given. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. Default order for ‘timeCreated’ is descending. Default order for ‘displayName’ is ascending. If no value is specified timeCreated is the default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DeploymentUpgradeCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_deployment_upgrades API.

list_deployment_versions(compartment_id, **kwargs)¶

Returns the list of available deployment versions.

Parameters:	compartment_id (str) – (required) The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. deployment_id (str) – (optional) The OCID of the deployment in which to list resources. deployment_type (str) – (optional) The type of deployment, the value determines the exact ‘type’ of the service executed in the deployment. Default value is DATABASE_ORACLE. Allowed values are: “OGG”, “DATABASE_ORACLE”, “BIGDATA”, “DATABASE_MICROSOFT_SQLSERVER”, “DATABASE_MYSQL”, “DATABASE_POSTGRESQL”, “DATABASE_DB2ZOS”, “GGSA”, “DATA_TRANSFORMS” opc_request_id (str) – (optional) The client request ID for tracing. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. Default order for ‘timeCreated’ is descending. Default order for ‘displayName’ is ascending. If no value is specified timeCreated is the default. Allowed values are: “timeCreated”, “displayName” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DeploymentVersionCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_deployment_versions API.

list_deployment_wallets_operations(deployment_id, **kwargs)¶

Lists the wallets export/import operations to/from a deployment.

Parameters:	deployment_id (str) – (required) A unique Deployment identifier. display_name (str) – (optional) A filter to return only the resources that match the entire ‘displayName’ given. opc_request_id (str) – (optional) The client request ID for tracing. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. Default order for ‘timeStarted’ is descending. Allowed values are: “timeStarted” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DeploymentWalletsOperationCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_deployment_wallets_operations API.

list_deployments(compartment_id, **kwargs)¶

Lists the Deployments in a compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. supported_connection_type (str) – (optional) The connection type which the deployment must support. Allowed values are: “GOLDENGATE”, “KAFKA”, “KAFKA_SCHEMA_REGISTRY”, “MYSQL”, “JAVA_MESSAGE_SERVICE”, “MICROSOFT_SQLSERVER”, “OCI_OBJECT_STORAGE”, “ORACLE”, “AZURE_DATA_LAKE_STORAGE”, “POSTGRESQL”, “AZURE_SYNAPSE_ANALYTICS”, “SNOWFLAKE”, “AMAZON_S3”, “HDFS”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY” assigned_connection_id (str) – (optional) The OCID of the connection which for the deployment must be assigned. assignable_connection_id (str) – (optional) Return the deployments to which the specified connectionId may be assigned. lifecycle_state (str) – (optional) A filter to return only the resources that match the ‘lifecycleState’ given. Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, “IN_PROGRESS”, “CANCELING”, “CANCELED”, “SUCCEEDED”, “WAITING” lifecycle_sub_state (str) – (optional) A filter to return only the resources that match the ‘lifecycleSubState’ given. Allowed values are: “RECOVERING”, “STARTING”, “STOPPING”, “MOVING”, “UPGRADING”, “RESTORING”, “BACKUP_IN_PROGRESS”, “ROLLBACK_IN_PROGRESS” display_name (str) – (optional) A filter to return only the resources that match the entire ‘displayName’ given. fqdn (str) – (optional) A filter to return only the resources that match the ‘fqdn’ given. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. Default order for ‘timeCreated’ is descending. Default order for ‘displayName’ is ascending. If no value is specified timeCreated is the default. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DeploymentCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_deployments API.

list_messages(deployment_id, **kwargs)¶

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:	deployment_id (str) – (required) A unique Deployment identifier. opc_request_id (str) – (optional) The client request ID for tracing. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DeploymentMessageCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_messages API.

list_trail_files(deployment_id, **kwargs)¶

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:	deployment_id (str) – (required) A unique Deployment identifier. display_name (str) – (optional) A filter to return only the resources that match the entire ‘displayName’ given. trail_file_id (str) – (optional) A Trail File identifier opc_request_id (str) – (optional) The client request ID for tracing. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. Default order for ‘timeLastUpdated’ is descending. Default order for ‘displayName’ is ascending. If no value is specified displayName is the default. Allowed values are: “timeLastUpdated”, “displayName” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TrailFileCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_trail_files API.

list_trail_sequences(deployment_id, trail_file_id, **kwargs)¶

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:	deployment_id (str) – (required) A unique Deployment identifier. trail_file_id (str) – (required) A Trail File identifier trail_sequence_id (str) – (optional) A Trail Sequence identifier display_name (str) – (optional) A filter to return only the resources that match the entire ‘displayName’ given. opc_request_id (str) – (optional) The client request ID for tracing. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_by (str) – (optional) The field to sort by. Only one sort order can be provided. Default order for ‘timeLastUpdated’ is descending. Default order for ‘displayName’ is ascending. If no value is specified displayName is the default. Allowed values are: “timeLastUpdated”, “displayName” sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TrailSequenceCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_trail_sequences API.

list_work_request_errors(work_request_id, **kwargs)¶

Lists work request errors.

Parameters:	work_request_id (str) – (required) The OCID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `WorkRequestError`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_request_errors API.

list_work_request_logs(work_request_id, **kwargs)¶

Lists work request logs.

Parameters:	work_request_id (str) – (required) The OCID of the asynchronous request. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `WorkRequestLogEntry`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_request_logs API.

list_work_requests(compartment_id, **kwargs)¶

Lists the work requests in the compartment.

Parameters:	compartment_id (str) – (required) The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request concerns multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used. resource_id (str) – (optional) The OCID of the resource in which to list resources. opc_request_id (str) – (optional) The client request ID for tracing. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. limit (int) – (optional) The maximum number of items to return. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `WorkRequest`
Return type:	`Response`
Example:

Click here to see an example of how to use list_work_requests API.

refresh_connection(connection_id, refresh_connection_details, **kwargs)¶

Refresh the external Connection attributes.

Parameters:	connection_id (str) – (required) The OCID of a Connection. refresh_connection_details (oci.golden_gate.models.RefreshConnectionDetails) – (required) Details of refresh external Connection attributes. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use refresh_connection API.

remove_connection_lock(connection_id, remove_resource_lock_details, **kwargs)¶

Removes a lock from a Connection resource.

Parameters:	connection_id (str) – (required) The OCID of a Connection. remove_resource_lock_details (oci.golden_gate.models.RemoveResourceLockDetails) – (required) RemoveResourceLockDetails body parameter opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Connection`
Return type:	`Response`
Example:

Click here to see an example of how to use remove_connection_lock API.

remove_deployment_backup_lock(deployment_backup_id, remove_resource_lock_details, **kwargs)¶

Removes a lock from a DeploymentBackup resource.

Parameters:	deployment_backup_id (str) – (required) A unique DeploymentBackup identifier. remove_resource_lock_details (oci.golden_gate.models.RemoveResourceLockDetails) – (required) RemoveResourceLockDetails body parameter opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DeploymentBackup`
Return type:	`Response`
Example:

Click here to see an example of how to use remove_deployment_backup_lock API.

remove_deployment_lock(deployment_id, remove_resource_lock_details, **kwargs)¶

Removes a lock from a Deployment resource.

Parameters:	deployment_id (str) – (required) A unique Deployment identifier. remove_resource_lock_details (oci.golden_gate.models.RemoveResourceLockDetails) – (required) RemoveResourceLockDetails body parameter opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Deployment`
Return type:	`Response`
Example:

Click here to see an example of how to use remove_deployment_lock API.

reschedule_deployment_upgrade(deployment_upgrade_id, reschedule_deployment_upgrade_details, **kwargs)¶

Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.

Parameters:	deployment_upgrade_id (str) – (required) A unique Deployment Upgrade identifier. reschedule_deployment_upgrade_details (oci.golden_gate.models.RescheduleDeploymentUpgradeDetails) – (required) Properties to reschedule DeploymentUpgrade. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DeploymentUpgrade`
Return type:	`Response`
Example:

Click here to see an example of how to use reschedule_deployment_upgrade API.

restore_deployment(deployment_backup_id, restore_deployment_details, **kwargs)¶

Restores a Deployment from a Deployment Backup created from the same Deployment.

Parameters:	deployment_backup_id (str) – (required) A unique DeploymentBackup identifier. restore_deployment_details (oci.golden_gate.models.RestoreDeploymentDetails) – (required) A placeholder for any additional metadata to describe the deployment restore. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use restore_deployment API.

rollback_deployment_upgrade(deployment_upgrade_id, rollback_deployment_upgrade_details, **kwargs)¶

Rollback a deployment to it’s previous version. When provided, If-Match is checked against ETag values of the resource.

Parameters:	deployment_upgrade_id (str) – (required) A unique Deployment Upgrade identifier. rollback_deployment_upgrade_details (oci.golden_gate.models.RollbackDeploymentUpgradeDetails) – (required) A placeholder for any additional metadata to describe the deployment rollback. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use rollback_deployment_upgrade API.

snooze_deployment_upgrade(deployment_upgrade_id, snooze_deployment_upgrade_details, **kwargs)¶

Snooze a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.

Parameters:	deployment_upgrade_id (str) – (required) A unique Deployment Upgrade identifier. snooze_deployment_upgrade_details (oci.golden_gate.models.SnoozeDeploymentUpgradeDetails) – (required) A placeholder for any additional metadata to describe the snooze of deployment upgrade. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use snooze_deployment_upgrade API.

start_deployment(deployment_id, start_deployment_details, **kwargs)¶

Starts a Deployment. When provided, If-Match is checked against ETag values of the resource.

Parameters:	deployment_id (str) – (required) A unique Deployment identifier. start_deployment_details (oci.golden_gate.models.StartDeploymentDetails) – (required) A placeholder for any additional metadata to describe the deployment start. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use start_deployment API.

stop_deployment(deployment_id, stop_deployment_details, **kwargs)¶

Stops a Deployment. When provided, If-Match is checked against ETag values of the resource.

Parameters:	deployment_id (str) – (required) A unique Deployment identifier. stop_deployment_details (oci.golden_gate.models.StopDeploymentDetails) – (required) A placeholder for any additional metadata to describe the deployment stop. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use stop_deployment API.

test_connection_assignment(connection_assignment_id, test_connection_assignment_details, **kwargs)¶

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:	connection_assignment_id (str) – (required) The OCID of the Connection Assignment. test_connection_assignment_details (oci.golden_gate.models.TestConnectionAssignmentDetails) – (required) A placeholder for any additional metadata to describe the requested tests of the assigned connection. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `TestConnectionAssignmentResult`
Return type:	`Response`
Example:

Click here to see an example of how to use test_connection_assignment API.

update_connection(connection_id, update_connection_details, **kwargs)¶

Updates the Connection.

Parameters:	connection_id (str) – (required) The OCID of a Connection. update_connection_details (oci.golden_gate.models.UpdateConnectionDetails) – (required) The new Connection specifications to apply. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_connection API.

update_database_registration(database_registration_id, update_database_registration_details, **kwargs)¶

Note: Deprecated. Use the /connections API instead. Updates the DatabaseRegistration.

Parameters:	database_registration_id (str) – (required) A unique DatabaseRegistration identifier. update_database_registration_details (oci.golden_gate.models.UpdateDatabaseRegistrationDetails) – (required) The new DatabaseRegistration specifications to apply. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_database_registration API.

update_deployment(deployment_id, update_deployment_details, **kwargs)¶

Modifies a Deployment.

Parameters:	deployment_id (str) – (required) A unique Deployment identifier. update_deployment_details (oci.golden_gate.models.UpdateDeploymentDetails) – (required) The information to be updated. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_deployment API.

update_deployment_backup(deployment_backup_id, update_deployment_backup_details, **kwargs)¶

Modifies a Deployment Backup.

Parameters:	deployment_backup_id (str) – (required) A unique DeploymentBackup identifier. update_deployment_backup_details (oci.golden_gate.models.UpdateDeploymentBackupDetails) – (required) The information to be updated. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DeploymentBackup`
Return type:	`Response`
Example:

Click here to see an example of how to use update_deployment_backup API.

upgrade_deployment(deployment_id, upgrade_deployment_details, **kwargs)¶

Upgrade a Deployment. When provided, If-Match is checked against ETag values of the resource.

Parameters:	deployment_id (str) – (required) A unique Deployment identifier. upgrade_deployment_details (oci.golden_gate.models.UpgradeDeploymentDetails) – (required) A placeholder for any additional metadata to describe the deployment upgrade. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use upgrade_deployment API.

upgrade_deployment_upgrade(deployment_upgrade_id, upgrade_deployment_upgrade_details, **kwargs)¶

Upgrade a deployment. When provided, If-Match is checked against ETag values of the resource.

Parameters:	deployment_upgrade_id (str) – (required) A unique Deployment Upgrade identifier. upgrade_deployment_upgrade_details (oci.golden_gate.models.UpgradeDeploymentUpgradeDetails) – (required) A placeholder for any additional metadata to describe the deployment upgrade. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource is updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried, in case of a timeout or server error, without the risk of executing that same action again. Retry tokens expire after 24 hours but can be invalidated before then due to conflicting operations. For example, if a resource was deleted and purged from the system, then a retry of the original creation request is rejected. is_lock_override (bool) – (optional) Whether to override locks (if any exist). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use upgrade_deployment_upgrade API.