Golden Gate Functions

Package: DBMS_CLOUD_OCI_GG_GOLDEN_GATE

CANCEL_DEPLOYMENT_BACKUP Function

Cancels a Deployment Backup creation process.

Syntax

FUNCTION cancel_deployment_backup (
  deployment_backup_id varchar2,
  cancel_deployment_backup_details dbms_cloud_oci_golden_gate_cancel_deployment_backup_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_cancel_deployment_backup_response_t;

Parameters

Parameter	Description
`deployment_backup_id`	(required) A unique DeploymentBackup identifier.
`cancel_deployment_backup_details`	(required) A placeholder for any additional metadata to describe the deployment backup cancel.
`if_match`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CANCEL_DEPLOYMENT_UPGRADE Function

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

Syntax

FUNCTION cancel_deployment_upgrade (
  deployment_upgrade_id varchar2,
  cancel_deployment_upgrade_details dbms_cloud_oci_golden_gate_cancel_deployment_upgrade_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_cancel_deployment_upgrade_response_t;

Parameters

Parameter	Description
`deployment_upgrade_id`	(required) A unique Deployment Upgrade identifier.
`cancel_deployment_upgrade_details`	(required) A placeholder for any additional metadata to describe the cancel snooze of deployment upgrade.
`if_match`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CANCEL_SNOOZE_DEPLOYMENT_UPGRADE Function

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

Syntax

FUNCTION cancel_snooze_deployment_upgrade (
  deployment_upgrade_id varchar2,
  cancel_snooze_deployment_upgrade_details dbms_cloud_oci_golden_gate_cancel_snooze_deployment_upgrade_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_cancel_snooze_deployment_upgrade_response_t;

Parameters

Parameter	Description
`deployment_upgrade_id`	(required) A unique Deployment Upgrade identifier.
`cancel_snooze_deployment_upgrade_details`	(required) A placeholder for any additional metadata to describe the cancel snooze of deployment upgrade.
`if_match`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_CONNECTION_COMPARTMENT Function

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.

Syntax

FUNCTION change_connection_compartment (
  connection_id varchar2,
  change_connection_compartment_details dbms_cloud_oci_golden_gate_change_connection_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_change_connection_compartment_response_t;

Parameters

Parameter	Description
`connection_id`	(required) The OCID of a Connection.
`change_connection_compartment_details`	(required) Properties to change the compartment of a Connection.
`if_match`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_DATABASE_REGISTRATION_COMPARTMENT Function

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.

Syntax

FUNCTION change_database_registration_compartment (
  database_registration_id varchar2,
  change_database_registration_compartment_details dbms_cloud_oci_golden_gate_change_database_registration_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_change_database_registration_compartment_response_t;

Parameters

Parameter	Description
`database_registration_id`	(required) A unique DatabaseRegistration identifier.
`change_database_registration_compartment_details`	(required) Properties to change the compartment of a DatabaseRegistration.
`if_match`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_DEPLOYMENT_BACKUP_COMPARTMENT Function

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.

Syntax

FUNCTION change_deployment_backup_compartment (
  deployment_backup_id varchar2,
  change_deployment_backup_compartment_details dbms_cloud_oci_golden_gate_change_deployment_backup_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_change_deployment_backup_compartment_response_t;

Parameters

Parameter	Description
`deployment_backup_id`	(required) A unique DeploymentBackup identifier.
`change_deployment_backup_compartment_details`	(required) Properties to change the compartment of a DeploymentBackup.
`if_match`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_DEPLOYMENT_COMPARTMENT Function

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.

Syntax

FUNCTION change_deployment_compartment (
  deployment_id varchar2,
  change_deployment_compartment_details dbms_cloud_oci_golden_gate_change_deployment_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_change_deployment_compartment_response_t;

Parameters

Parameter	Description
`deployment_id`	(required) A unique Deployment identifier.
`change_deployment_compartment_details`	(required) Properties to change the compartment of a Deployment.
`if_match`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

COLLECT_DEPLOYMENT_DIAGNOSTIC Function

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

Syntax

FUNCTION collect_deployment_diagnostic (
  deployment_id varchar2,
  collect_deployment_diagnostic_details dbms_cloud_oci_golden_gate_collect_deployment_diagnostic_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_collect_deployment_diagnostic_response_t;

Parameters

Parameter	Description
`deployment_id`	(required) A unique Deployment identifier.
`collect_deployment_diagnostic_details`	(required) Metadata about the deployment diagnostic. This also includes the Object storage information where the diagnostic will be uploaded
`if_match`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

COPY_DEPLOYMENT_BACKUP Function

Creates a copy of a Deployment Backup.

Syntax

FUNCTION copy_deployment_backup (
  deployment_backup_id varchar2,
  copy_deployment_backup_details dbms_cloud_oci_golden_gate_copy_deployment_backup_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_copy_deployment_backup_response_t;

Parameters

Parameter	Description
`deployment_backup_id`	(required) A unique DeploymentBackup identifier.
`copy_deployment_backup_details`	(required) A placeholder for any additional metadata to describe the copy of a Deployment Backup.
`if_match`	(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`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_CERTIFICATE Function

Creates a new certificate to truststore.

Syntax

FUNCTION create_certificate (
  create_certificate_details dbms_cloud_oci_golden_gate_create_certificate_details_t,
  deployment_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_create_certificate_response_t;

Parameters

Parameter	Description
`create_certificate_details`	(required) Specifications to create the certificate to truststore.
`deployment_id`	(required) A unique Deployment identifier.
`opc_retry_token`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_CONNECTION Function

Creates a new Connection.

Syntax

FUNCTION create_connection (
  create_connection_details dbms_cloud_oci_golden_gate_create_connection_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_create_connection_response_t;

Parameters

Parameter	Description
`create_connection_details`	(required) Specification of the Connection to create.
`opc_retry_token`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_CONNECTION_ASSIGNMENT Function

Creates a new Connection Assignment.

Syntax

FUNCTION create_connection_assignment (
  create_connection_assignment_details dbms_cloud_oci_golden_gate_create_connection_assignment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_create_connection_assignment_response_t;

Parameters

Parameter	Description
`create_connection_assignment_details`	(required) Specification of the connection assignment to create.
`opc_retry_token`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_DATABASE_REGISTRATION Function

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

Syntax

FUNCTION create_database_registration (
  create_database_registration_details dbms_cloud_oci_golden_gate_create_database_registration_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_create_database_registration_response_t;

Parameters

Parameter	Description
`create_database_registration_details`	(required) Specification of the DatabaseRegistration to create.
`opc_retry_token`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_DEPLOYMENT Function

Creates a new Deployment.

Syntax

FUNCTION create_deployment (
  create_deployment_details dbms_cloud_oci_golden_gate_create_deployment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_create_deployment_response_t;

Parameters

Parameter	Description
`create_deployment_details`	(required) Specifications to create the Deployment.
`opc_retry_token`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_DEPLOYMENT_BACKUP Function

Creates a new DeploymentBackup.

Syntax

FUNCTION create_deployment_backup (
  create_deployment_backup_details dbms_cloud_oci_golden_gate_create_deployment_backup_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_create_deployment_backup_response_t;

Parameters

Parameter	Description
`create_deployment_backup_details`	(required) Specification of the DeploymentBackup to create.
`opc_retry_token`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_CERTIFICATE Function

Deletes the certificate from truststore.

Syntax

FUNCTION delete_certificate (
  deployment_id varchar2,
  certificate_key varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_delete_certificate_response_t;

Parameters

Parameter	Description
`deployment_id`	(required) A unique Deployment identifier.
`certificate_key`	(required) A unique certificate identifier.
`if_match`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_CONNECTION Function

Deletes a Connection.

Syntax

FUNCTION delete_connection (
  connection_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_delete_connection_response_t;

Parameters

Parameter	Description
`connection_id`	(required) The OCID of a Connection.
`if_match`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_CONNECTION_ASSIGNMENT Function

Deletes a Connection Assignment.

Syntax

FUNCTION delete_connection_assignment (
  connection_assignment_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_delete_connection_assignment_response_t;

Parameters

Parameter	Description
`connection_assignment_id`	(required) The OCID of the Connection Assignment.
`if_match`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DATABASE_REGISTRATION Function

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

Syntax

FUNCTION delete_database_registration (
  database_registration_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_delete_database_registration_response_t;

Parameters

Parameter	Description
`database_registration_id`	(required) A unique DatabaseRegistration identifier.
`if_match`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DEPLOYMENT Function

Deletes the Deployment.

Syntax

FUNCTION delete_deployment (
  deployment_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_delete_deployment_response_t;

Parameters

Parameter	Description
`deployment_id`	(required) A unique Deployment identifier.
`if_match`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DEPLOYMENT_BACKUP Function

Deletes a DeploymentBackup.

Syntax

FUNCTION delete_deployment_backup (
  deployment_backup_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_delete_deployment_backup_response_t;

Parameters

Parameter	Description
`deployment_backup_id`	(required) A unique DeploymentBackup identifier.
`if_match`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DEPLOYMENT_WALLET_EXISTS Function

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

Syntax

FUNCTION deployment_wallet_exists (
  deployment_id varchar2,
  deployment_wallet_exists_details dbms_cloud_oci_golden_gate_deployment_wallet_exists_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_deployment_wallet_exists_response_t;

Parameters

Parameter	Description
`deployment_id`	(required) A unique Deployment identifier.
`deployment_wallet_exists_details`	(required) A placeholder for any additional metadata to describe the deployment start.
`if_match`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

EXPORT_DEPLOYMENT_WALLET Function

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

Syntax

FUNCTION export_deployment_wallet (
  deployment_id varchar2,
  export_deployment_wallet_details dbms_cloud_oci_golden_gate_export_deployment_wallet_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_export_deployment_wallet_response_t;

Parameters

Parameter	Description
`deployment_id`	(required) A unique Deployment identifier.
`export_deployment_wallet_details`	(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`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_CERTIFICATE Function

Retrieves a Certificate.

Syntax

FUNCTION get_certificate (
  deployment_id varchar2,
  certificate_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_get_certificate_response_t;

Parameters

Parameter	Description
`deployment_id`	(required) A unique Deployment identifier.
`certificate_key`	(required) A unique certificate identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_CONNECTION Function

Retrieves a Connection.

Syntax

FUNCTION get_connection (
  connection_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_get_connection_response_t;

Parameters

Parameter	Description
`connection_id`	(required) The OCID of a Connection.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_CONNECTION_ASSIGNMENT Function

Retrieves a Connection Assignment.

Syntax

FUNCTION get_connection_assignment (
  connection_assignment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_get_connection_assignment_response_t;

Parameters

Parameter	Description
`connection_assignment_id`	(required) The OCID of the Connection Assignment.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DATABASE_REGISTRATION Function

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

Syntax

FUNCTION get_database_registration (
  database_registration_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_get_database_registration_response_t;

Parameters

Parameter	Description
`database_registration_id`	(required) A unique DatabaseRegistration identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DEPLOYMENT Function

Retrieves a deployment.

Syntax

FUNCTION get_deployment (
  deployment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_get_deployment_response_t;

Parameters

Parameter	Description
`deployment_id`	(required) A unique Deployment identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DEPLOYMENT_BACKUP Function

Retrieves a DeploymentBackup.

Syntax

FUNCTION get_deployment_backup (
  deployment_backup_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_get_deployment_backup_response_t;

Parameters

Parameter	Description
`deployment_backup_id`	(required) A unique DeploymentBackup identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DEPLOYMENT_UPGRADE Function

Retrieves a deployment upgrade.

Syntax

FUNCTION get_deployment_upgrade (
  deployment_upgrade_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_get_deployment_upgrade_response_t;

Parameters

Parameter	Description
`deployment_upgrade_id`	(required) A unique Deployment Upgrade identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

Retrieve the WorkRequest identified by the given OCID.

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

IMPORT_DEPLOYMENT_WALLET Function

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

Syntax

FUNCTION import_deployment_wallet (
  deployment_id varchar2,
  import_deployment_wallet_details dbms_cloud_oci_golden_gate_import_deployment_wallet_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_import_deployment_wallet_response_t;

Parameters

Parameter	Description
`deployment_id`	(required) A unique Deployment identifier.
`import_deployment_wallet_details`	(required) Metadata to import wallet to deployment. This also includes the OCI Vault information where the wallet will be imported from
`if_match`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CERTIFICATES Function

Returns a list of certificates from truststore.

Syntax

FUNCTION list_certificates (
  deployment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_list_certificates_response_t;

Parameters

Parameter	Description
`deployment_id`	(required) A unique Deployment identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`lifecycle_state`	(optional) A filter to return only connections having the 'lifecycleState' given. Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CONNECTION_ASSIGNMENTS Function

Lists the Connection Assignments in the compartment.

Syntax

FUNCTION list_connection_assignments (
  compartment_id varchar2,
  deployment_id varchar2 DEFAULT NULL,
  connection_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_list_connection_assignments_response_t;

Parameters

Parameter	Description
`compartment_id`	(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`	(optional) The OCID of the deployment in which to list resources.
`connection_id`	(optional) The OCID of the connection.
`name`	(optional) The name of the connection in the assignment (aliasName).
`lifecycle_state`	(optional) A filter to return only connection assignments having the 'lifecycleState' given.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CONNECTIONS Function

Lists the Connections in the compartment.

Syntax

FUNCTION list_connections (
  compartment_id varchar2,
  technology_type dbms_cloud_oci_golden_gate_varchar2_tbl DEFAULT NULL,
  connection_type dbms_cloud_oci_golden_gate_varchar2_tbl DEFAULT NULL,
  assigned_deployment_id varchar2 DEFAULT NULL,
  assignable_deployment_id varchar2 DEFAULT NULL,
  assignable_deployment_type varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_list_connections_response_t;

Parameters

Parameter	Description
`compartment_id`	(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`	(optional) The array of technology types. Allowed values are: 'GOLDENGATE', 'GENERIC', 'OCI_AUTONOMOUS_DATABASE', 'OCI_AUTONOMOUS_JSON_DATABASE', 'OCI_MYSQL', 'OCI_OBJECT_STORAGE', 'OCI_STREAMING', 'ORACLE_DATABASE', 'ORACLE_EXADATA', '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_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', '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', 'POSTGRESQL_SERVER', 'REDIS', 'SINGLESTOREDB', 'SINGLESTOREDB_CLOUD', 'SNOWFLAKE'
`connection_type`	(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', 'REDIS', 'ELASTICSEARCH', 'GENERIC', 'GOOGLE_CLOUD_STORAGE', 'GOOGLE_BIGQUERY'
`assigned_deployment_id`	(optional) The OCID of the deployment which for the connection must be assigned.
`assignable_deployment_id`	(optional) Filters for compatible connections which can be, but currently not assigned to the deployment specified by its id.
`assignable_deployment_type`	(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`	(optional) A filter to return only connections having the 'lifecycleState' given.
`display_name`	(optional) A filter to return only the resources that match the entire 'displayName' given.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DATABASE_REGISTRATIONS Function

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

Syntax

FUNCTION list_database_registrations (
  compartment_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_list_database_registrations_response_t;

Parameters

Parameter	Description
`compartment_id`	(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`	(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`	(optional) A filter to return only the resources that match the entire 'displayName' given.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DEPLOYMENT_BACKUPS Function

Lists the Backups in a compartment.

Syntax

FUNCTION list_deployment_backups (
  compartment_id varchar2,
  deployment_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_list_deployment_backups_response_t;

Parameters

Parameter	Description
`compartment_id`	(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`	(optional) The OCID of the deployment in which to list resources.
`lifecycle_state`	(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`	(optional) A filter to return only the resources that match the entire 'displayName' given.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DEPLOYMENT_TYPES Function

Returns an array of DeploymentTypeDescriptor

Syntax

FUNCTION list_deployment_types (
  compartment_id varchar2,
  deployment_type varchar2 DEFAULT NULL,
  ogg_version varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_list_deployment_types_response_t;

Parameters

Parameter	Description
`compartment_id`	(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`	(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`	(optional) Allows to query by a specific GoldenGate version.
`display_name`	(optional) A filter to return only the resources that match the entire 'displayName' given.
`opc_request_id`	(optional) The client request ID for tracing.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DEPLOYMENT_UPGRADES Function

Lists the Deployment Upgrades in a compartment.

Syntax

FUNCTION list_deployment_upgrades (
  compartment_id varchar2,
  deployment_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_list_deployment_upgrades_response_t;

Parameters

Parameter	Description
`compartment_id`	(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`	(optional) The OCID of the deployment in which to list resources.
`lifecycle_state`	(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`	(optional) A filter to return only the resources that match the entire 'displayName' given.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DEPLOYMENT_VERSIONS Function

Returns the list of available deployment versions.

Syntax

FUNCTION list_deployment_versions (
  compartment_id varchar2,
  deployment_id varchar2 DEFAULT NULL,
  deployment_type varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_list_deployment_versions_response_t;

Parameters

Parameter	Description
`compartment_id`	(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`	(optional) The OCID of the deployment in which to list resources.
`deployment_type`	(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`	(optional) The client request ID for tracing.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DEPLOYMENT_WALLETS_OPERATIONS Function

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

Syntax

FUNCTION list_deployment_wallets_operations (
  deployment_id varchar2,
  display_name varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_list_deployment_wallets_operations_response_t;

Parameters

Parameter	Description
`deployment_id`	(required) A unique Deployment identifier.
`display_name`	(optional) A filter to return only the resources that match the entire 'displayName' given.
`opc_request_id`	(optional) The client request ID for tracing.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_by`	(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`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DEPLOYMENTS Function

Lists the Deployments in a compartment.

Syntax

FUNCTION list_deployments (
  compartment_id varchar2,
  supported_connection_type varchar2 DEFAULT NULL,
  assigned_connection_id varchar2 DEFAULT NULL,
  assignable_connection_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  lifecycle_sub_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  fqdn varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_list_deployments_response_t;

Parameters

Parameter	Description
`compartment_id`	(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`	(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', 'REDIS', 'ELASTICSEARCH', 'GENERIC', 'GOOGLE_CLOUD_STORAGE', 'GOOGLE_BIGQUERY'
`assigned_connection_id`	(optional) The OCID of the connection which for the deployment must be assigned.
`assignable_connection_id`	(optional) Return the deployments to which the specified connectionId may be assigned.
`lifecycle_state`	(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`	(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`	(optional) A filter to return only the resources that match the entire 'displayName' given.
`fqdn`	(optional) A filter to return only the resources that match the 'fqdn' given.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MESSAGES Function

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.

Syntax

FUNCTION list_messages (
  deployment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_list_messages_response_t;

Parameters

Parameter	Description
`deployment_id`	(required) A unique Deployment identifier.
`opc_request_id`	(optional) The client request ID for tracing.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_TRAIL_FILES Function

Lists the TrailFiles for a deployment.

Syntax

FUNCTION list_trail_files (
  deployment_id varchar2,
  display_name varchar2 DEFAULT NULL,
  trail_file_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_list_trail_files_response_t;

Parameters

Parameter	Description
`deployment_id`	(required) A unique Deployment identifier.
`display_name`	(optional) A filter to return only the resources that match the entire 'displayName' given.
`trail_file_id`	(optional) A Trail File identifier
`opc_request_id`	(optional) The client request ID for tracing.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_by`	(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`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_TRAIL_SEQUENCES Function

Lists the Trail Sequences for a TrailFile in a given deployment.

Syntax

FUNCTION list_trail_sequences (
  deployment_id varchar2,
  trail_file_id varchar2,
  trail_sequence_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_list_trail_sequences_response_t;

Parameters

Parameter	Description
`deployment_id`	(required) A unique Deployment identifier.
`trail_file_id`	(required) A Trail File identifier
`trail_sequence_id`	(optional) A Trail Sequence identifier
`display_name`	(optional) A filter to return only the resources that match the entire 'displayName' given.
`opc_request_id`	(optional) The client request ID for tracing.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_by`	(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`	(optional) The sort order to use, either 'asc' or 'desc'. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_ERRORS Function

Lists work request errors.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_LOGS Function

Lists work request logs.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

Lists the work requests in the compartment.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  resource_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(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`	(optional) The OCID of the resource in which to list resources.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

RESCHEDULE_DEPLOYMENT_UPGRADE Function

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

Syntax

FUNCTION reschedule_deployment_upgrade (
  deployment_upgrade_id varchar2,
  reschedule_deployment_upgrade_details dbms_cloud_oci_golden_gate_reschedule_deployment_upgrade_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_reschedule_deployment_upgrade_response_t;

Parameters

Parameter	Description
`deployment_upgrade_id`	(required) A unique Deployment Upgrade identifier.
`reschedule_deployment_upgrade_details`	(required) Properties to reschedule DeploymentUpgrade.
`if_match`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

RESTORE_DEPLOYMENT Function

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

Syntax

FUNCTION restore_deployment (
  deployment_backup_id varchar2,
  restore_deployment_details dbms_cloud_oci_golden_gate_restore_deployment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_restore_deployment_response_t;

Parameters

Parameter	Description
`deployment_backup_id`	(required) A unique DeploymentBackup identifier.
`restore_deployment_details`	(required) A placeholder for any additional metadata to describe the deployment restore.
`if_match`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ROLLBACK_DEPLOYMENT_UPGRADE Function

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

Syntax

FUNCTION rollback_deployment_upgrade (
  deployment_upgrade_id varchar2,
  rollback_deployment_upgrade_details dbms_cloud_oci_golden_gate_rollback_deployment_upgrade_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_rollback_deployment_upgrade_response_t;

Parameters

Parameter	Description
`deployment_upgrade_id`	(required) A unique Deployment Upgrade identifier.
`rollback_deployment_upgrade_details`	(required) A placeholder for any additional metadata to describe the deployment rollback.
`if_match`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SNOOZE_DEPLOYMENT_UPGRADE Function

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

Syntax

FUNCTION snooze_deployment_upgrade (
  deployment_upgrade_id varchar2,
  snooze_deployment_upgrade_details dbms_cloud_oci_golden_gate_snooze_deployment_upgrade_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_snooze_deployment_upgrade_response_t;

Parameters

Parameter	Description
`deployment_upgrade_id`	(required) A unique Deployment Upgrade identifier.
`snooze_deployment_upgrade_details`	(required) A placeholder for any additional metadata to describe the snooze of deployment upgrade.
`if_match`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

START_DEPLOYMENT Function

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

Syntax

FUNCTION start_deployment (
  deployment_id varchar2,
  start_deployment_details dbms_cloud_oci_golden_gate_start_deployment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_start_deployment_response_t;

Parameters

Parameter	Description
`deployment_id`	(required) A unique Deployment identifier.
`start_deployment_details`	(required) A placeholder for any additional metadata to describe the deployment start.
`if_match`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

STOP_DEPLOYMENT Function

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

Syntax

FUNCTION stop_deployment (
  deployment_id varchar2,
  stop_deployment_details dbms_cloud_oci_golden_gate_stop_deployment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_stop_deployment_response_t;

Parameters

Parameter	Description
`deployment_id`	(required) A unique Deployment identifier.
`stop_deployment_details`	(required) A placeholder for any additional metadata to describe the deployment stop.
`if_match`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

TEST_CONNECTION_ASSIGNMENT Function

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.

Syntax

FUNCTION test_connection_assignment (
  connection_assignment_id varchar2,
  test_connection_assignment_details dbms_cloud_oci_golden_gate_test_connection_assignment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_test_connection_assignment_response_t;

Parameters

Parameter	Description
`connection_assignment_id`	(required) The OCID of the Connection Assignment.
`test_connection_assignment_details`	(required) A placeholder for any additional metadata to describe the requested tests of the assigned connection.
`if_match`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_CONNECTION Function

Updates the Connection.

Syntax

FUNCTION update_connection (
  connection_id varchar2,
  update_connection_details dbms_cloud_oci_golden_gate_update_connection_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_update_connection_response_t;

Parameters

Parameter	Description
`connection_id`	(required) The OCID of a Connection.
`update_connection_details`	(required) The new Connection specifications to apply.
`if_match`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DATABASE_REGISTRATION Function

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

Syntax

FUNCTION update_database_registration (
  database_registration_id varchar2,
  update_database_registration_details dbms_cloud_oci_golden_gate_update_database_registration_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_update_database_registration_response_t;

Parameters

Parameter	Description
`database_registration_id`	(required) A unique DatabaseRegistration identifier.
`update_database_registration_details`	(required) The new DatabaseRegistration specifications to apply.
`if_match`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DEPLOYMENT Function

Modifies a Deployment.

Syntax

FUNCTION update_deployment (
  deployment_id varchar2,
  update_deployment_details dbms_cloud_oci_golden_gate_update_deployment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_update_deployment_response_t;

Parameters

Parameter	Description
`deployment_id`	(required) A unique Deployment identifier.
`update_deployment_details`	(required) The information to be updated.
`if_match`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DEPLOYMENT_BACKUP Function

Modifies a Deployment Backup.

Syntax

FUNCTION update_deployment_backup (
  deployment_backup_id varchar2,
  update_deployment_backup_details dbms_cloud_oci_golden_gate_update_deployment_backup_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_update_deployment_backup_response_t;

Parameters

Parameter	Description
`deployment_backup_id`	(required) A unique DeploymentBackup identifier.
`update_deployment_backup_details`	(required) The information to be updated.
`if_match`	(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`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPGRADE_DEPLOYMENT Function

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

Syntax

FUNCTION upgrade_deployment (
  deployment_id varchar2,
  upgrade_deployment_details dbms_cloud_oci_golden_gate_upgrade_deployment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_upgrade_deployment_response_t;

Parameters

Parameter	Description
`deployment_id`	(required) A unique Deployment identifier.
`upgrade_deployment_details`	(required) A placeholder for any additional metadata to describe the deployment upgrade.
`if_match`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPGRADE_DEPLOYMENT_UPGRADE Function

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

Syntax

FUNCTION upgrade_deployment_upgrade (
  deployment_upgrade_id varchar2,
  upgrade_deployment_upgrade_details dbms_cloud_oci_golden_gate_upgrade_deployment_upgrade_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_gg_golden_gate_upgrade_deployment_upgrade_response_t;

Parameters

Parameter	Description
`deployment_upgrade_id`	(required) A unique Deployment Upgrade identifier.
`upgrade_deployment_upgrade_details`	(required) A placeholder for any additional metadata to describe the deployment upgrade.
`if_match`	(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`	(optional) The client request ID for tracing.
`opc_retry_token`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://goldengate.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation