Golden Gate¶
Use the Oracle Cloud Infrastructure GoldenGate APIs to perform data replication operations. |
|
This class provides a wrapper around |
Models¶
The information about adding a deployment peer in list. |
|
Used to add a resource lock. |
|
Represents authentication details for an AI Model connection. |
|
Summary of authentication details for an AI Model connection. |
|
Collection of AI models currently known by GoldenGate for the specified provider. |
|
Represents the metadata of an AI Model Connection. |
|
Summary of the AI Model Connection. |
|
Summary details of an AI model supported by a provider. |
|
Collection of AI providers supported by GoldenGate. |
|
Represents the metadata of an AI Provider Connection. |
|
Summary of the AI Provider Connection. |
|
Summary details of an AI provider and its supported models. |
|
Represents the metadata of a Amazon Kinesis Connection. |
|
Summary of the Amazon Kinesis Connection. |
|
Represents the metadata of a Amazon Redshift Connection. |
|
Summary of the Amazon Redshift Connection. |
|
Represents the metadata of a Amazon S3 Connection. |
|
Summary of the Amazon S3 Connection. |
|
Represents an Amazon S3 storage used in the Iceberg connection. |
|
Summary of the Amazon S3 storage used in the Iceberg connection. |
|
API key authentication details for an AI Model connection. |
|
Summary of API key authentication details for an AI Model connection. |
|
Represents the metadata of a Azure Data Lake Storage Connection. |
|
|
Summary of the Azure Data Lake Storage Connection. |
|
Represents an Azure Data Lake Storage Gen2 location used to share Databricks application artifacts. |
|
Summary of an Azure Data Lake Storage Gen2 location used to share Databricks application artifacts. |
Represents an Azure Data Lake Storage storage used in the Iceberg connection. |
|
|
Summary of the Azure Data Lake Storage storage used in the Iceberg connection. |
Represents the metadata of a Azure Synapse Analytics Connection. |
|
Summary of the Azure Synapse Analytics Connection. |
|
Defines the schedule of the deployment backup. |
|
The information about the Cancel for a DeploymentBackup. |
|
The information about canceling. |
|
The information about snooze canceling. |
|
Certificate data. |
|
A list of Certificates. |
|
Summary of the Certificates. |
|
The new compartment for a Connection. |
|
The configuration details for associating the GoldenGate connection resource with a different subscription. |
|
|
The new compartment for a DatabaseRegistration. |
|
The new compartment for a DeploymentBackup. |
The new compartment for a Deployment. |
|
The configuration details for associating the GoldenGate deployment resource with a different subscription. |
|
The new compartment for a Pipeline. |
|
The configuration details for associating the resource with a different subscription. |
|
Details for a pipeline clone. |
|
Details for collecting deployment diagnostic |
|
Details for collecting pipeline diagnostics |
|
Represents the metadata description of a connection used by deployments in the same compartment. |
|
Represents the metadata description of a connection assignment. |
|
List of connection summary objects. |
|
Summary of the Connection Assignment. |
|
List of connection summary objects. |
|
Summary of the Connection. |
|
The information about the copy for a Deployment Backup. |
|
The information about new authentication details for an AI Model connection. |
|
The information about a new AI Model Connection. |
|
The information about a new AI Provider Connection. |
|
The information about a new Amazon Kinesis Connection. |
|
|
The information about a new Amazon Redshift Connection. |
The information about a new Amazon S3 Connection. |
|
The information about a new Amazon S3 storage used in the Iceberg connection. |
|
The information about new API key authentication details for an AI Model connection. |
|
|
The information about a new Azure Data Lake Storage Connection. |
|
The information about an Azure Data Lake Storage Gen2 location used to share Databricks application artifacts. |
|
The information about a new Azure Data Lake Storage storage used in the Iceberg connection. |
The information about a new Azure Synapse Analytics Connection. |
|
Defines the backup schedule details for create operation. |
|
The information about a new Certificates. |
|
The information about a new Connection Assignment. |
|
The information about a new Connection. |
|
The information about a new DatabaseRegistration. |
|
The information about a new Databricks Connection. |
|
|
The information about a location used to share Databricks application artifacts. |
|
The information about a new Databricks Engine Connection. |
|
Configuration for creating an OCI Object Storage Databricks Engine artifact location. |
|
Pre-authenticated request URL details for creating an OCI Object Storage Databricks Engine artifact location. |
|
Resource-principal authentication and location details for creating an OCI Object Storage Databricks Engine artifact location. |
|
Secret-key authentication and location details for creating an OCI Object Storage Databricks Engine artifact location. |
|
User-principal authentication and location details for creating an OCI Object Storage Databricks Engine artifact location. |
The information about a new DB2 Connection. |
|
The information about a new DeploymentBackup. |
|
The information about a new Deployment. |
|
The information about a new Elasticsearch Connection. |
|
The information about a new Generic Connection. |
|
The information about a new a Glue catalog used in the Iceberg connection. |
|
The information about a new GoldenGate Connection. |
|
|
The information about a new Google BigQuery Connection. |
|
The information about a new Google Cloud Storage Connection. |
|
The information about a new Google Cloud Storage storage used in the Iceberg connection. |
The information about a new Google PubSub Connection. |
|
The information about a new Hadoop catalog used in the Iceberg connection. |
|
The information about a new Hadoop Distributed File System Connection. |
|
The information about a new catalog of given type used in an Iceberg connection. |
|
The information about a new Iceberg Connection. |
|
The information about a new storage of given type used in an Iceberg connection. |
|
|
The information about a new Java Message Service Connection. |
Represents a Kafka bootstrap server with host name, optional port defaults to 9092. |
|
The information about a new Kafka Connection. |
|
|
The information about a new Kafka (e.g. |
|
Defines the maintenance configuration for create operation. |
Defines the maintenance window for create operation, when automatic actions can be performed. |
|
|
The information about a new Microsoft Fabric Connection. |
|
The information about a new Microsoft SQL Server Connection. |
The information about a new MongoDB Connection. |
|
The information about a new MySQL Connection. |
|
The information about a new Nessie catalog used in the Iceberg connection. |
|
The information indicating the absence of a storage configuration in an Iceberg connection. |
|
The information about new OCI Generative AI authentication details for an AI Model connection. |
|
|
The information about a new OCI Object Storage Connection. |
|
The information about an OCI Object Storage location used to share Databricks application artifacts. |
|
The information to create the OCI Object Storage (S3 Compatibility API) configuration used by the Iceberg connection. |
|
The information about an OCI Object Storage location used to share Spark application artifacts. |
Deployment Data for creating an OggDeployment. |
|
|
The information about a new Oracle AI Data Platform Connection. |
|
The information about a new Oracle AI Data Platform Engine Connection. |
The information about a new Oracle Database Connection. |
|
The information about a new Oracle NoSQL Connection. |
|
Details with which to create a pipeline. |
|
The information about a new Polaris catalog used in the Iceberg connection. |
|
The information about a new PostgreSQL Connection. |
|
The information about a new Redis Connection. |
|
The information about a new Rest catalog used in the Iceberg connection. |
|
The information about a new Snowflake Connection. |
|
The information about a location used to share Spark application artifacts with a remote cluster. |
|
The information about a new Spark Connection. |
|
|
Configuration for creating an OCI Object Storage Spark artifact location. |
|
Pre-authenticated request URL details for creating an OCI Object Storage Spark artifact location. |
|
Resource-principal authentication and location details for creating an OCI Object Storage Spark artifact location. |
|
Secret-key authentication and location details for creating an OCI Object Storage Spark artifact location. |
|
User-principal authentication and location details for creating an OCI Object Storage Spark artifact location. |
|
The information about a Unity Catalog volume location used to share Databricks application artifacts. |
Creation details for a new ZeroETL pipeline. |
|
Represents the metadata description of a database used by deployments in the same compartment. |
|
A list of DatabaseRegistrations. |
|
Summary of the DatabaseRegistration. |
|
Represents the metadata of a Databricks Connection. |
|
Summary of the Databricks Connection. |
|
Represents the location used to share Databricks application artifacts. |
|
|
Summary of the location used to share Databricks application artifacts. |
Represents the metadata of a Databricks Engine Connection. |
|
Summary of the Databricks Engine Connection. |
|
|
Configuration for an OCI Object Storage Databricks Engine artifact location. |
|
Pre-authenticated request URL details for an OCI Object Storage Databricks Engine artifact location. |
|
Resource-principal authentication and location details for an OCI Object Storage Databricks Engine artifact location. |
|
Secret-key authentication and location details for an OCI Object Storage Databricks Engine artifact location. |
|
User-principal authentication and location details for an OCI Object Storage Databricks Engine artifact location. |
Represents the metadata of a DB2 Connection. |
|
Summary of the DB2 Connection. |
|
Definition of the additional attributes for default deployment backup cancel. |
|
|
Definition of the additional attributes for default deployment upgrade cancel. |
|
Definition of the additional attributes for default deployment upgrade cancel snooze. |
Attribute details for a default pipeline clone. |
|
Definition of the additional attributes for default check of a wallet in deployment . |
|
Attribute details for a default pipeline pause. |
|
Definition of the additional attributes for default Connection external attributes. |
|
Definition of the additional attributes for default deployment restore. |
|
|
Definition of the additional attributes for default upgrade rollback. |
|
Definition of the additional attributes for default deployment upgrade snooze. |
Definition of the additional attributes for default deployment start. |
|
Attribute details for a default pipeline start. |
|
Definition of the additional attributes for default deployment stop. |
|
Attribute details for a default pipeline stop. |
|
|
Definition of the additional attributes for default test of assigned connection. |
Additional attribute with which to test the pipeline's connection. |
|
|
Definition of the additional attributes for default deployment upgrade. |
A container for your OCI GoldenGate resources, such as the OCI GoldenGate deployment console. |
|
A backup of the current state of the GoldenGate deployment. |
|
A list of DeploymentBackups. |
|
The summary of the Backup. |
|
A list of Deployments. |
|
Information regarding the deployment diagnostic collection |
|
The list of DeploymentEnvironmentDescriptor objects. |
|
The metadata specific to a production or development/testing environment. |
|
A list of DeploymentMessages. |
|
A list of DeploymentPeers. |
|
The summary of the deployment Peer. |
|
Specifies a possible deployment placement. |
|
Specifies a deployment placement with explicit availability and fault domain specification. |
|
Summary of the Deployment. |
|
The list of DeploymentTypeDescriptor objects. |
|
The meta-data specific on particular deployment type represented by deploymentType field. |
|
A container for your OCI GoldenGate Upgrade information. |
|
A list of Deployment Upgrades. |
|
Summary of the Deployment Upgrade. |
|
The list of DeploymentVersionSummary objects. |
|
The summary data of a specific deployment version. |
|
The information to check if a wallet is present in the Deployment. |
|
|
Indicates whether the wallet exists in the deployment container |
A list of deployment wallets operations. |
|
Summary of the deployment wallets operations. |
|
DR precheck result for standby peer in the specified placement (availabilityDomain and faultDomain). |
|
A single precheck result. |
|
Represents the metadata of a Elasticsearch Connection. |
|
Summary of the Elasticsearch Connection. |
|
Metadata required to export wallet from deployment |
|
|
Metadata required to submit to generate a DR precheck report. |
The information about generating the library URL. |
|
|
Definition of the additional attributes for default library URL generation. |
Represents the metadata of a Generic Connection. |
|
Summary of the Generic Connection. |
|
Represents a Glue catalog used in the Iceberg connection. |
|
Summary of a Glue catalog used in the Iceberg connection. |
|
Represents the metadata of a GoldenGate Connection. |
|
Summary of the GoldenGate Connection. |
|
Represents the metadata of a Google BigQuery Connection. |
|
Summary of the Google BigQuery Connection. |
|
Represents the metadata of a Google Cloud Storage Connection. |
|
Summary of the Google Cloud Storage Connection. |
|
Represents a Google Cloud Storage storage used in the Iceberg connection. |
|
|
Summary of the Google Cloud Storage storage used in the Iceberg connection. |
Represents the metadata of a Google PubSub Connection. |
|
Summary of the Google PubSub Connection. |
|
Defines the IDP Groups to GoldenGate roles mapping. |
|
Represents a Hadoop catalog used in the Iceberg connection. |
|
Summary of the Hadoop catalog used in the Iceberg connection. |
|
Represents the metadata of a Hadoop Distributed File System Connection. |
|
Summary of the Hadoop Distributed File System Connection. |
|
Represents the catalog of given type used in an Iceberg connection. |
|
Summary of the catalog of given type used in an Iceberg connection. |
|
Represents the metadata of an Iceberg Connection. |
|
Summary of the Iceberg Connection. |
|
Represents the storage of given type used in an Iceberg connection. |
|
Summary of the storage of given type used in an Iceberg connection. |
|
Metadata required to import wallet to deployment |
|
Private Endpoint IP Addresses created in the customer's subnet. |
|
Options required for the pipeline Initial Data Load. |
|
Represents the metadata of a Java Message Service Connection. |
|
Summary of the Java Message Service Connection. |
|
Represents a Kafka bootstrap server with host name, optional port defaults to 9092. |
|
Represents the metadata of a Kafka Connection. |
|
Summary of the Kafka Connection. |
|
Represents the metadata of a Kafka (e.g. |
|
Summary of the Kafka (e.g. |
|
A Pre-Authenticated Request Object URL to a DB2 for z/OS library that needs to be uploaded to your DB2 for z/OS server in order to establish GoldenGate connections to it. |
|
Attributes for configuring automatic deployment maintenance. |
|
Defines the maintenance window, when automatic actions can be performed. |
|
Mapping rule for source and target schemas for the pipeline data replication. |
|
Deployment message Summary. |
|
Represents the metadata of a Microsoft Fabric Connection. |
|
Summary of the Microsoft Fabric Connection. |
|
Represents the metadata of a Microsoft SQL Server Connection. |
|
Summary of the Microsoft SQL Server Connection. |
|
The information about the Migrate Connection. |
|
Represents the metadata of a MongoDB Connection. |
|
Summary of the MongoDB Connection. |
|
Represents the metadata of a MySQL Connection. |
|
Summary of the MySQL Connection. |
|
A name-value pair representing an attribute entry usable in a list of attributes. |
|
Represents a Nessie catalog used in the Iceberg connection. |
|
Summary of the Nessie catalog used in the Iceberg connection. |
|
Represents the absence of a storage configuration in an Iceberg connection. |
|
Summary of the absence of a storage configuration in an Iceberg connection. |
|
OCI Generative AI authentication details for an AI Model connection. |
|
Summary of OCI Generative AI authentication details for an AI Model connection. |
|
Represents the metadata of an OCI Object Storage Connection. |
|
Summary of the OCI Object Storage Connection. |
|
|
Represents an OCI Object Storage location used to share Databricks application artifacts. |
|
Summary of an OCI Object Storage location used to share Databricks application artifacts. |
Connection details of the OCI Object Storage (S3 Compatibility API) configuration used by the Iceberg connection. |
|
|
Summary of the OCI Object Storage (S3 Compatibility API) configuration used by the Iceberg connection. |
|
Represents an OCI Object Storage location used to share Spark application artifacts. |
|
Summary of an OCI Object Storage location used to share Spark application artifacts. |
Deployment Data for an OggDeployment. |
|
Represents the metadata of an Oracle AI Data Platform Connection. |
|
|
Summary of the Oracle AI Data Platform Connection. |
Represents the metadata of an Oracle AI Data Platform Engine Connection. |
|
|
Summary of the Oracle AI Data Platform Engine Connection. |
Represents the metadata of an Oracle Database Connection. |
|
Summary of the Oracle Connection. |
|
Represents the metadata of an Oracle NoSQL Connection. |
|
Summary of the Oracle NoSQL Connection. |
|
Details for a pipeline pause. |
|
Represents the metadata details of a pipeline in the same compartment. |
|
List of pipeline summary objects. |
|
Information regarding the pipeline diagnostic collection |
|
The step and its progress based on the recipe type. |
|
The steps and their progress, based on the recipe type. |
|
The complete replication process and its details. |
|
Each replication process and their summary details. |
|
The list of schemas present in the source/target connection database of a pipeline. |
|
List of source and target schemas of a pipeline's assigned connection. |
|
List of source or target schema tables of a pipeline's assigned connection. |
|
Summary of source or target schema tables of a pipeline's assigned connection. |
|
Summary details of the pipeline. |
|
Represents a Polaris catalog used in the Iceberg connection. |
|
Summary of the Polaris catalog used in the Iceberg connection. |
|
Represents the metadata of a PostgreSQL Database Connection. |
|
Summary of the PostgreSQL Database Connection. |
|
Required pipeline options to configure the replication process (Extract or Replicat). |
|
The list of recipe details to create pipelines. |
|
The list of Recipe objects. |
|
Represents the metadata of a Redis Database Connection. |
|
Summary of the Redis Database Connection. |
|
The information about the Refresh Connection external attributes. |
|
The information about removing a deployment peer. |
|
Used to remove a resource lock. |
|
Options required for pipeline Initial Data Load. |
|
The information about canceling. |
|
|
Definition of the additional attributes for default deployment upgrade cancel. |
Resource locks are used to prevent certain APIs from being called for the resource. |
|
Represents a Rest catalog used in the Iceberg connection. |
|
Summary of the Rest catalog used in the Iceberg connection. |
|
The information about the Restore for a Deployment. |
|
The information about the rollback of an upgrade. |
|
Definition of the additional attributes for secret Connection migrate. |
|
The information about the snooze for a deployment. |
|
Represents the metadata of a Snowflake Connection. |
|
Summary of the Snowflake Connection. |
|
The source connection details for creating a pipeline. |
|
Represents the location used to share Spark application artifacts with a remote cluster. |
|
Summary of the location used to share Spark application artifacts with a remote cluster. |
|
Represents the metadata of a Spark Connection. |
|
Summary of the Spark Connection. |
|
Configuration for an OCI Object Storage Spark artifact location. |
|
Pre-authenticated request URL details for an OCI Object Storage Spark artifact location. |
|
|
Resource-principal authentication and location details for an OCI Object Storage Spark artifact location. |
Secret-key authentication and location details for an OCI Object Storage Spark artifact location. |
|
|
User-principal authentication and location details for an OCI Object Storage Spark artifact location. |
The information about the Start for a Deployment. |
|
Details with which to start a pipeline. |
|
Contents of a step message. |
|
The information about the Stop for a Deployment. |
|
Details for a pipeline stop. |
|
The information about switching to deployment peer. |
|
The target connection details for creating a pipeline. |
|
The information about testing the assigned connection. |
|
Error Information. |
|
The result of the connectivity test performed between the GoldenGate deployment and the associated database / service. |
|
Details about testing the pipeline's assigned connection. |
|
The error returned when a pipeline connection fails to connect. |
|
Result of the connectivity test performed on a pipeline's assigned connection. |
|
A list of TrailFiles. |
|
Summary of the TrailFiles. |
|
A list of TrailSequences. |
|
Summary of the TrailSequences. |
|
|
Represents a Unity Catalog volume location used to share Databricks application artifacts. |
|
Summary of a Unity Catalog volume location used to share Databricks application artifacts. |
The information to update authentication details for an AI Model connection. |
|
The information to update an AI Model Connection. |
|
The information to update an AI Provider Connection. |
|
The information to update a the Amazon Kinesis Connection. |
|
|
The information to update a the Amazon Redshift Connection. |
The information to update a the Amazon S3 Connection. |
|
The information to update the Amazon S3 storage used in the Iceberg connection. |
|
The information to update API key authentication details for an AI Model connection. |
|
|
The information to update a Azure Data Lake Storage Connection. |
|
The information to update an Azure Data Lake Storage Gen2 location used to share Databricks application artifacts. |
|
The information to update the Azure Data Lake Storage storage used in the Iceberg connection. |
The information to update a Azure Synapse Analytics Connection. |
|
Defines the backup schedule details for update operation. |
|
The information to update a Connection. |
|
The information to update a DatabaseRegistration. |
|
The information to update a Databricks Connection. |
|
|
The information to update a location used to share Databricks application artifacts. |
|
The information to update a Databricks Engine Connection. |
|
Configuration for updating an OCI Object Storage Databricks Engine artifact location. |
|
Pre-authenticated request URL details for updating an OCI Object Storage Databricks Engine artifact location. |
|
Resource-principal authentication and location details for updating an OCI Object Storage Databricks Engine artifact location. |
|
Secret-key authentication and location details for updating an OCI Object Storage Databricks Engine artifact location. |
|
User-principal authentication and location details for updating an OCI Object Storage Databricks Engine artifact location. |
The information to update a DB2 Connection. |
|
The information to use to update a Deployment Backup. |
|
The information to use to update a Deployment. |
|
The information to update a Elasticsearch Connection. |
|
The information to update a Generic Connection. |
|
The information to update a Glue catalog used in the Iceberg connection. |
|
The information to update a GoldenGate Connection. |
|
|
The information to update a the Google BigQuery Connection. |
|
The information to update a the Google Cloud Storage Connection. |
|
The information to update the Google Cloud Storage storage used in the Iceberg connection. |
The information to update a the Google PubSub Connection. |
|
Defines the IDP Groups to GoldenGate roles mapping. |
|
The information to update a Hadoop catalog used in the Iceberg connection. |
|
The information to update a Hadoop Distributed File System Connection. |
|
The information to update a catalog of given type used in an Iceberg connection. |
|
The information to update an Iceberg Connection. |
|
The information to update a storage of given type used in an Iceberg connection. |
|
|
The information to update a Java Message Service Connection. |
The information to update a Kafka Connection. |
|
|
The information to update Kafka (e.g. |
|
Defines the maintenance configuration for update operation. |
Defines the maintenance window for update operation, when automatic actions can be performed. |
|
|
The information to update a Microsoft Fabric Connection. |
|
The information to update a Microsoft SQL Server Connection. |
The information to update a MongoDB Connection. |
|
The information to update a MySQL Connection. |
|
The information to update a Nessie catalog used in the Iceberg connection. |
|
The information to update the absence of a storage configuration in an Iceberg connection. |
|
The information to update OCI Generative AI authentication details for an AI Model connection. |
|
|
The information to update a OCI Object Storage Connection. |
|
The information to update an OCI Object Storage location used to share Databricks application artifacts. |
|
The information to update the OCI Object Storage (S3 Compatibility API) configuration used by the Iceberg connection. |
|
The information to update an OCI Object Storage location used to share Spark application artifacts. |
Deployment Details for updating an OggDeployment. |
|
|
The information to update a Oracle AI Data Platform Connection. |
|
The information to update an Oracle AI Data Platform Engine Connection. |
The information to update an Oracle Database Connection. |
|
The information to update a Oracle NoSQL Connection. |
|
Information with which to update a pipeline. |
|
The information to update a Polaris catalog used in the Iceberg connection. |
|
The information to update a PostgreSQL Database Connection. |
|
The information to update a Redis Database Connection. |
|
The information to update a Rest catalog used in the Iceberg connection. |
|
The information to update a Snowflake Connection. |
|
The information to update a location used to share Spark application artifacts with a remote cluster. |
|
The information to update a Spark Connection. |
|
|
Configuration for updating an OCI Object Storage Spark artifact location. |
|
Pre-authenticated request URL details for updating an OCI Object Storage Spark artifact location. |
|
Resource-principal authentication and location details for updating an OCI Object Storage Spark artifact location. |
|
Secret-key authentication and location details for updating an OCI Object Storage Spark artifact location. |
|
User-principal authentication and location details for updating an OCI Object Storage Spark artifact location. |
|
The information to update a Unity Catalog volume location used to share Databricks application artifacts. |
Information to update for an existing ZeroETL pipeline. |
|
|
Definition of the additional attributes for a Current Release upgrade. |
The information about the Upgrade for a Deployment. |
|
|
Definition of the additional attributes for a Specific Release upgrade. |
The information about the upgrade for a deployment. |
|
The API operations that create and configure GoldenGate resources do not take effect immediately. |
|
An error encountered while executing a work request. |
|
A log message from the execution of a work request. |
|
A resource created or operated on by a work request. |
|
The details of a ZeroETL pipeline. |
|
Summary of the ZeroETL pipeline. |