Namespace Oci.GoldengateService.Models
Classes
AddDeploymentLocalPeerDetails
The information about adding a deployment peer in list.
AddResourceLockDetails
Used to add a resource lock. Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.
AmazonKinesisConnection
Represents the metadata of a Amazon Kinesis Connection.
AmazonKinesisConnectionSummary
Summary of the Amazon Kinesis Connection.
AmazonRedshiftConnection
Represents the metadata of a Amazon Redshift Connection.
AmazonRedshiftConnectionSummary
Summary of the Amazon Redshift Connection.
AmazonS3Connection
Represents the metadata of a Amazon S3 Connection.
AmazonS3ConnectionSummary
Summary of the Amazon S3 Connection.
AmazonS3IcebergStorage
Represents an Amazon S3 storage used in the Iceberg connection.
AmazonS3IcebergStorageSummary
Summary of the Amazon S3 storage used in the Iceberg connection.
AzureDataLakeStorageConnection
Represents the metadata of a Azure Data Lake Storage Connection.
AzureDataLakeStorageConnectionSummary
Summary of the Azure Data Lake Storage Connection.
AzureDataLakeStorageIcebergStorage
Represents an Azure Data Lake Storage storage used in the Iceberg connection.
AzureDataLakeStorageIcebergStorageSummary
Summary of the Azure Data Lake Storage storage used in the Iceberg connection.
AzureSynapseConnection
Represents the metadata of a Azure Synapse Analytics Connection.
AzureSynapseConnectionSummary
Summary of the Azure Synapse Analytics Connection.
BackupSchedule
Defines the schedule of the deployment backup.
CancelDeploymentBackupDetails
The information about the Cancel for a DeploymentBackup.
CancelDeploymentBackupDetailsModelConverter
CancelDeploymentUpgradeDetails
The information about canceling.
CancelDeploymentUpgradeDetailsModelConverter
CancelSnoozeDeploymentUpgradeDetails
The information about snooze canceling.
CancelSnoozeDeploymentUpgradeDetailsModelConverter
Certificate
Certificate data.
CertificateCollection
A list of Certificates.
CertificateSummary
Summary of the Certificates.
ChangeConnectionCompartmentDetails
The new compartment for a Connection.
ChangeDatabaseRegistrationCompartmentDetails
The new compartment for a DatabaseRegistration.
ChangeDeploymentBackupCompartmentDetails
The new compartment for a DeploymentBackup.
ChangeDeploymentCompartmentDetails
The new compartment for a Deployment.
ChangePipelineCompartmentDetails
The new compartment for a Pipeline.
CollectDeploymentDiagnosticDetails
Details for collecting deployment diagnostic
CollectPipelineDiagnosticDetails
Details for collecting pipeline diagnostics
Connection
Represents the metadata description of a connection used by deployments in the same compartment.
ConnectionAssignment
Represents the metadata description of a connection assignment. Before you can use a connection as a GoldenGate source or target, you must assign it to a deployment.
ConnectionAssignmentCollection
List of connection summary objects.
ConnectionAssignmentSummary
Summary of the Connection Assignment.
ConnectionCollection
List of connection summary objects.
ConnectionModelConverter
ConnectionSummary
Summary of the Connection.
ConnectionSummaryModelConverter
CopyDeploymentBackupDetails
The information about the copy for a Deployment Backup.
CreateAmazonKinesisConnectionDetails
The information about a new Amazon Kinesis Connection.
CreateAmazonRedshiftConnectionDetails
The information about a new Amazon Redshift Connection.
CreateAmazonS3ConnectionDetails
The information about a new Amazon S3 Connection.
CreateAmazonS3IcebergStorageDetails
The information about a new Amazon S3 storage used in the Iceberg connection.
CreateAzureDataLakeStorageConnectionDetails
The information about a new Azure Data Lake Storage Connection.
CreateAzureDataLakeStorageIcebergStorageDetails
The information about a new Azure Data Lake Storage storage used in the Iceberg connection.
CreateAzureSynapseConnectionDetails
The information about a new Azure Synapse Analytics Connection.
CreateBackupScheduleDetails
Defines the backup schedule details for create operation.
CreateCertificateDetails
The information about a new Certificates.
CreateConnectionAssignmentDetails
The information about a new Connection Assignment.
CreateConnectionDetails
The information about a new Connection.
CreateConnectionDetailsModelConverter
CreateDatabaseRegistrationDetails
The information about a new DatabaseRegistration.
CreateDatabricksConnectionDetails
The information about a new Databricks Connection.
CreateDb2ConnectionDetails
The information about a new DB2 Connection.
CreateDeploymentBackupDetails
The information about a new DeploymentBackup.
CreateDeploymentDetails
The information about a new Deployment.
CreateElasticsearchConnectionDetails
The information about a new Elasticsearch Connection.
CreateGenericConnectionDetails
The information about a new Generic Connection.
CreateGlueIcebergCatalogDetails
The information about a new a Glue catalog used in the Iceberg connection.
CreateGoldenGateConnectionDetails
The information about a new GoldenGate Connection.
CreateGoogleBigQueryConnectionDetails
The information about a new Google BigQuery Connection.
CreateGoogleCloudStorageConnectionDetails
The information about a new Google Cloud Storage Connection.
CreateGoogleCloudStorageIcebergStorageDetails
The information about a new Google Cloud Storage storage used in the Iceberg connection.
CreateGooglePubSubConnectionDetails
The information about a new Google PubSub Connection.
CreateHadoopIcebergCatalogDetails
The information about a new Hadoop catalog used in the Iceberg connection.
CreateHdfsConnectionDetails
The information about a new Hadoop Distributed File System Connection.
CreateIcebergCatalogDetails
The information about a new catalog of given type used in an Iceberg connection.
CreateIcebergCatalogDetailsModelConverter
CreateIcebergConnectionDetails
The information about a new Iceberg Connection.
CreateIcebergStorageDetails
The information about a new storage of given type used in an Iceberg connection.
CreateIcebergStorageDetailsModelConverter
CreateJavaMessageServiceConnectionDetails
The information about a new Java Message Service Connection.
CreateKafkaConnectionDetails
The information about a new Kafka Connection.
CreateKafkaSchemaRegistryConnectionDetails
The information about a new Kafka (e.g. Confluent) Schema Registry Connection.
CreateMaintenanceConfigurationDetails
Defines the maintenance configuration for create operation.
CreateMaintenanceWindowDetails
Defines the maintenance window for create operation, when automatic actions can be performed.
CreateMicrosoftFabricConnectionDetails
The information about a new Microsoft Fabric Connection.
CreateMicrosoftSqlserverConnectionDetails
The information about a new Microsoft SQL Server Connection.
CreateMongoDbConnectionDetails
The information about a new MongoDB Connection.
CreateMysqlConnectionDetails
The information about a new MySQL Connection.
CreateNessieIcebergCatalogDetails
The information about a new Nessie catalog used in the Iceberg connection.
CreateOciObjectStorageConnectionDetails
The information about a new OCI Object Storage Connection.
CreateOggDeploymentDetails
Deployment Data for creating an OggDeployment
CreateOracleConnectionDetails
The information about a new Oracle Database Connection.
CreateOracleNosqlConnectionDetails
The information about a new Oracle NoSQL Connection.
CreatePipelineDetails
Details with which to create a pipeline.
CreatePipelineDetailsModelConverter
CreatePolarisIcebergCatalogDetails
The information about a new Polaris catalog used in the Iceberg connection.
CreatePostgresqlConnectionDetails
The information about a new PostgreSQL Connection.
CreateRedisConnectionDetails
The information about a new Redis Connection.
CreateRestIcebergCatalogDetails
The information about a new Rest catalog used in the Iceberg connection.
CreateSnowflakeConnectionDetails
The information about a new Snowflake Connection.
CreateZeroEtlPipelineDetails
Creation details for a new ZeroETL pipeline.
DatabaseRegistration
Represents the metadata description of a database used by deployments in the same compartment.
DatabaseRegistrationCollection
A list of DatabaseRegistrations.
DatabaseRegistrationSummary
Summary of the DatabaseRegistration.
DatabricksConnection
Represents the metadata of a Databricks Connection.
DatabricksConnectionSummary
Summary of the Databricks Connection.
Db2Connection
Represents the metadata of a DB2 Connection.
Db2ConnectionSummary
Summary of the DB2 Connection.
DefaultCancelDeploymentBackupDetails
Definition of the additional attributes for default deployment backup cancel.
DefaultCancelDeploymentUpgradeDetails
Definition of the additional attributes for default deployment upgrade cancel.
DefaultCancelSnoozeDeploymentUpgradeDetails
Definition of the additional attributes for default deployment upgrade cancel snooze.
DefaultDeploymentWalletExistsDetails
Definition of the additional attributes for default check of a wallet in deployment .
DefaultRefreshConnectionDetails
Definition of the additional attributes for default Connection external attributes.
DefaultRestoreDeploymentDetails
Definition of the additional attributes for default deployment restore.
DefaultRollbackDeploymentUpgradeDetails
Definition of the additional attributes for default upgrade rollback.
DefaultSnoozeDeploymentUpgradeDetails
Definition of the additional attributes for default deployment upgrade snooze.
DefaultStartDeploymentDetails
Definition of the additional attributes for default deployment start.
DefaultStartPipelineDetails
Attribute details for a default pipeline start.
DefaultStopDeploymentDetails
Definition of the additional attributes for default deployment stop.
DefaultStopPipelineDetails
Attribute details for a default pipeline stop.
DefaultTestConnectionAssignmentDetails
Definition of the additional attributes for default test of assigned connection.
DefaultTestPipelineConnectionDetails
Additional attribute with which to test the pipeline's connection. The connectionId must be one of the pipeline's assigned connections.
DefaultUpgradeDeploymentUpgradeDetails
Definition of the additional attributes for default deployment upgrade.
Deployment
A container for your OCI GoldenGate resources, such as the OCI GoldenGate deployment console.
DeploymentBackup
A backup of the current state of the GoldenGate deployment. Can be used to restore a deployment, or create a new deployment with that state as the starting deployment state.
DeploymentBackupCollection
A list of DeploymentBackups.
DeploymentBackupSummary
The summary of the Backup.
DeploymentCollection
A list of Deployments.
DeploymentDiagnosticData
Information regarding the deployment diagnostic collection
DeploymentEnvironmentCollection
The list of DeploymentEnvironmentDescriptor objects.
DeploymentEnvironmentSummary
The metadata specific to a production or development/testing environment.
DeploymentMessageCollection
A list of DeploymentMessages.
DeploymentPeerCollection
A list of DeploymentPeers.
DeploymentPeerSummary
The summary of the deployment Peer.
DeploymentPlacementDetails
Specifies a possible deployment placement. Placement either explicitly specifies the availability and fault domain, or it is partial and lets Oracle to find an optimal placement.
DeploymentPlacementInfo
Specifies a deployment placement with explicit availability and fault domain specification.
DeploymentSummary
Summary of the Deployment.
DeploymentTypeCollection
The list of DeploymentTypeDescriptor objects.
DeploymentTypeSummary
The meta-data specific on particular deployment type represented by deploymentType field.
Deprecated properties: sourceTechnologies and targetTechnologies are not populated. They will be removed after September 15 2025.
The list of supported source and target technologies can be accessed using the url provided in supportedTechnologiesUrl property.
DeploymentUpgrade
A container for your OCI GoldenGate Upgrade information.
DeploymentUpgradeCollection
A list of Deployment Upgrades.
DeploymentUpgradeSummary
Summary of the Deployment Upgrade.
DeploymentVersionCollection
The list of DeploymentVersionSummary objects.
DeploymentVersionSummary
The summary data of a specific deployment version.
DeploymentWalletExistsDetails
The information to check if a wallet is present in the Deployment.
DeploymentWalletExistsDetailsModelConverter
DeploymentWalletExistsResponseDetails
Indicates whether the wallet exists in the deployment container
DeploymentWalletsOperationCollection
A list of deployment wallets operations.
DeploymentWalletsOperationSummary
Summary of the deployment wallets operations.
ElasticsearchConnection
Represents the metadata of a Elasticsearch Connection.
ElasticsearchConnectionSummary
Summary of the Elasticsearch Connection.
ExportDeploymentWalletDetails
Metadata required to export wallet from deployment
GenerateLibraryUrlDetails
The information about generating the library URL.
GenerateLibraryUrlDetailsModelConverter
GenerateLogReaderComponentLibraryUrlDetails
Definition of the additional attributes for default library URL generation.
GenericConnection
Represents the metadata of a Generic Connection.
GenericConnectionSummary
Summary of the Generic Connection.
GlueIcebergCatalog
Represents a Glue catalog used in the Iceberg connection.
GlueIcebergCatalogSummary
Summary of a Glue catalog used in the Iceberg connection.
GoldenGateConnection
Represents the metadata of a GoldenGate Connection.
GoldenGateConnectionSummary
Summary of the GoldenGate Connection.
GoogleBigQueryConnection
Represents the metadata of a Google BigQuery Connection.
GoogleBigQueryConnectionSummary
Summary of the Google BigQuery Connection.
GoogleCloudStorageConnection
Represents the metadata of a Google Cloud Storage Connection.
GoogleCloudStorageConnectionSummary
Summary of the Google Cloud Storage Connection.
GoogleCloudStorageIcebergStorage
Represents a Google Cloud Storage storage used in the Iceberg connection.
GoogleCloudStorageIcebergStorageSummary
Summary of the Google Cloud Storage storage used in the Iceberg connection.
GooglePubSubConnection
Represents the metadata of a Google PubSub Connection.
GooglePubSubConnectionSummary
Summary of the Google PubSub Connection.
GroupToRolesMappingDetails
Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to.
HadoopIcebergCatalog
Represents a Hadoop catalog used in the Iceberg connection.
HadoopIcebergCatalogSummary
Summary of the Hadoop catalog used in the Iceberg connection.
HdfsConnection
Represents the metadata of a Hadoop Distributed File System Connection.
HdfsConnectionSummary
Summary of the Hadoop Distributed File System Connection.
IcebergCatalog
Represents the catalog of given type used in an Iceberg connection.
IcebergCatalogModelConverter
IcebergCatalogSummary
Summary of the catalog of given type used in an Iceberg connection.
IcebergCatalogSummaryModelConverter
IcebergConnection
Represents the metadata of an Iceberg Connection.
IcebergConnectionSummary
Summary of the Iceberg Connection.
IcebergStorage
Represents the storage of given type used in an Iceberg connection.
IcebergStorageModelConverter
IcebergStorageSummary
Summary of the storage of given type used in an Iceberg connection.
IcebergStorageSummaryModelConverter
ImportDeploymentWalletDetails
Metadata required to import wallet to deployment
IngressIpDetails
Private Endpoint IP Addresses created in the customer's subnet. GoldenGate service will use these ingress IP addresses to send all specific requests initiated from the service. These are typically used for accessing customer resources.
InitialDataLoad
Options required for the pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
JavaMessageServiceConnection
Represents the metadata of a Java Message Service Connection.
JavaMessageServiceConnectionSummary
Summary of the Java Message Service Connection.
KafkaBootstrapServer
Represents a Kafka bootstrap server with host name, optional port defaults to 9092, and an optional private ip.
KafkaConnection
Represents the metadata of a Kafka Connection.
KafkaConnectionSummary
Summary of the Kafka Connection.
KafkaSchemaRegistryConnection
Represents the metadata of a Kafka (e.g. Confluent) Schema Registry Connection.
KafkaSchemaRegistryConnectionSummary
Summary of the Kafka (e.g. Confluent) Schema Registry Connection.
LibraryUrl
A Pre-Authenticated Request Object URL to a DB2 for z/OS library that needs to be uploaded to your DB2 for z/OS server in order to establish GoldenGate connections to it. For licensing reasons, the URL is accessible for 10 minutes only.
MaintenanceConfiguration
Attributes for configuring automatic deployment maintenance.
MaintenanceWindow
Defines the maintenance window, when automatic actions can be performed.
MappingRule
Mapping rule for source and target schemas for the pipeline data replication. For Example: "{mappingType: INCLUDE, source: HR., target: HR.}" for rule "Include HR.*" which will include all the tables under HR schema.
MessageSummary
Deployment message Summary.
MicrosoftFabricConnection
Represents the metadata of a Microsoft Fabric Connection.
MicrosoftFabricConnectionSummary
Summary of the Microsoft Fabric Connection.
MicrosoftSqlserverConnection
Represents the metadata of a Microsoft SQL Server Connection.
MicrosoftSqlserverConnectionSummary
Summary of the Microsoft SQL Server Connection.
MongoDbConnection
Represents the metadata of a MongoDB Connection.
MongoDbConnectionSummary
Summary of the MongoDB Connection.
MysqlConnection
Represents the metadata of a MySQL Connection.
MysqlConnectionSummary
Summary of the MySQL Connection.
NameValuePair
A name-value pair representing an attribute entry usable in a list of attributes.
NessieIcebergCatalog
Represents a Nessie catalog used in the Iceberg connection.
NessieIcebergCatalogSummary
Summary of the Nessie catalog used in the Iceberg connection.
OciObjectStorageConnection
Represents the metadata of an OCI Object Storage Connection.
OciObjectStorageConnectionSummary
Summary of the OCI Object Storage Connection.
OggDeployment
Deployment Data for an OggDeployment
OracleConnection
Represents the metadata of an Oracle Database Connection.
OracleConnectionSummary
Summary of the Oracle Connection.
OracleNosqlConnection
Represents the metadata of an Oracle NoSQL Connection.
OracleNosqlConnectionSummary
Summary of the Oracle NoSQL Connection.
Pipeline
Represents the metadata details of a pipeline in the same compartment.
PipelineCollection
List of pipeline summary objects.
PipelineDiagnosticData
Information regarding the pipeline diagnostic collection
PipelineInitializationStep
The step and its progress based on the recipe type.
PipelineInitializationSteps
The steps and their progress, based on the recipe type.
PipelineModelConverter
PipelineRunningProcessCollection
The complete replication process and its details.
PipelineRunningProcessSummary
Each replication process and their summary details.
PipelineSchemaCollection
The list of schemas present in the source/target connection database of a pipeline.
PipelineSchemaSummary
List of source and target schemas of a pipeline's assigned connection.
- If there is no explicit mapping defined for the pipeline then only matched source and target schema names will be returned.
- If there are explicit mappings defined for the pipeline then along with the mapped source and target schema names, the matched source and target schema names also will be returned.
PipelineSchemaTableCollection
List of source or target schema tables of a pipeline's assigned connection.
PipelineSchemaTableSummary
Summary of source or target schema tables of a pipeline's assigned connection.
- If there is no explicit mapping defined for the pipeline then only matched source and target schema's table names will be returned
- If there are explicit mappings defined for the pipeline then along with the mapped source and target schema's table names, the matched source and target schema's table names also will be returned.
PipelineSummary
Summary details of the pipeline.
PipelineSummaryModelConverter
PolarisIcebergCatalog
Represents a Polaris catalog used in the Iceberg connection.
PolarisIcebergCatalogSummary
Summary of the Polaris catalog used in the Iceberg connection.
PostgresqlConnection
Represents the metadata of a PostgreSQL Database Connection.
PostgresqlConnectionSummary
Summary of the PostgreSQL Database Connection.
ProcessOptions
Required pipeline options to configure the replication process (Extract or Replicat).
RecipeSummary
The list of recipe details to create pipelines.
RecipeSummaryCollection
The list of Recipe objects.
RedisConnection
Represents the metadata of a Redis Database Connection.
RedisConnectionSummary
Summary of the Redis Database Connection.
RefreshConnectionDetails
The information about the Refresh Connection external attributes.
RefreshConnectionDetailsModelConverter
RemoveDeploymentLocalPeerDetails
The information about removing a deployment peer.
RemoveResourceLockDetails
Used to remove a resource lock. Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.
ReplicateSchemaChange
Options required for pipeline Initial Data Load. If enabled, copies existing data from source to target before replication.
RescheduleDeploymentUpgradeDetails
The information about canceling.
RescheduleDeploymentUpgradeDetailsModelConverter
RescheduleDeploymentUpgradeToDateDetails
Definition of the additional attributes for default deployment upgrade cancel.
ResourceLock
Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.
RestIcebergCatalog
Represents a Rest catalog used in the Iceberg connection.
RestIcebergCatalogSummary
Summary of the Rest catalog used in the Iceberg connection.
RestoreDeploymentDetails
The information about the Restore for a Deployment.
RestoreDeploymentDetailsModelConverter
RollbackDeploymentUpgradeDetails
The information about the rollback of an upgrade.
RollbackDeploymentUpgradeDetailsModelConverter
SnoozeDeploymentUpgradeDetails
The information about the snooze for a deployment.
SnoozeDeploymentUpgradeDetailsModelConverter
SnowflakeConnection
Represents the metadata of a Snowflake Connection.
SnowflakeConnectionSummary
Summary of the Snowflake Connection.
SourcePipelineConnectionDetails
The source connection details for creating a pipeline.
StartDeploymentDetails
The information about the Start for a Deployment.
StartDeploymentDetailsModelConverter
StartPipelineDetails
Details with which to start a pipeline.
StartPipelineDetailsModelConverter
StepMessage
Contents of a step message.
StopDeploymentDetails
The information about the Stop for a Deployment.
StopDeploymentDetailsModelConverter
StopPipelineDetails
Details for a pipeline stop.
StopPipelineDetailsModelConverter
SwitchoverDeploymentPeerDetails
The information about switching to deployment peer.
TargetPipelineConnectionDetails
The target connection details for creating a pipeline.
TestConnectionAssignmentDetails
The information about testing the assigned connection.
TestConnectionAssignmentDetailsModelConverter
TestConnectionAssignmentError
Error Information.
TestConnectionAssignmentResult
The result of the connectivity test performed between the GoldenGate deployment and the associated database / service. The 'error' property is deprecated and will not contain values in the future. So, the error(s) will be returned in just the 'errors' property.
TestPipelineConnectionDetails
Details about testing the pipeline's assigned connection.
TestPipelineConnectionDetailsModelConverter
TestPipelineConnectionError
The error returned when a pipeline connection fails to connect.
TestPipelineConnectionResult
Result of the connectivity test performed on a pipeline's assigned connection.
TrailFileCollection
A list of TrailFiles.
TrailFileSummary
Summary of the TrailFiles.
TrailSequenceCollection
A list of TrailSequences.
TrailSequenceSummary
Summary of the TrailSequences.
UpdateAmazonKinesisConnectionDetails
The information to update a the Amazon Kinesis Connection.
UpdateAmazonRedshiftConnectionDetails
The information to update a the Amazon Redshift Connection.
UpdateAmazonS3ConnectionDetails
The information to update a the Amazon S3 Connection.
UpdateAmazonS3IcebergStorageDetails
The information to update the Amazon S3 storage used in the Iceberg connection.
UpdateAzureDataLakeStorageConnectionDetails
The information to update a Azure Data Lake Storage Connection.
UpdateAzureDataLakeStorageIcebergStorageDetails
The information to update the Azure Data Lake Storage storage used in the Iceberg connection.
UpdateAzureSynapseConnectionDetails
The information to update a Azure Synapse Analytics Connection.
UpdateBackupScheduleDetails
Defines the backup schedule details for update operation.
UpdateConnectionDetails
The information to update a Connection.
UpdateConnectionDetailsModelConverter
UpdateDatabaseRegistrationDetails
The information to update a DatabaseRegistration.
UpdateDatabricksConnectionDetails
The information to update a Databricks Connection.
UpdateDb2ConnectionDetails
The information to update a DB2 Connection.
UpdateDeploymentBackupDetails
The information to use to update a Deployment Backup.
UpdateDeploymentDetails
The information to use to update a Deployment.
UpdateElasticsearchConnectionDetails
The information to update a Elasticsearch Connection.
UpdateGenericConnectionDetails
The information to update a Generic Connection.
UpdateGlueIcebergCatalogDetails
The information to update a Glue catalog used in the Iceberg connection.
UpdateGoldenGateConnectionDetails
The information to update a GoldenGate Connection.
UpdateGoogleBigQueryConnectionDetails
The information to update a the Google BigQuery Connection.
UpdateGoogleCloudStorageConnectionDetails
The information to update a the Google Cloud Storage Connection.
UpdateGoogleCloudStorageIcebergStorageDetails
The information to update the Google Cloud Storage storage used in the Iceberg connection.
UpdateGooglePubSubConnectionDetails
The information to update a the Google PubSub Connection.
UpdateGroupToRolesMappingDetails
Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to.
UpdateHadoopIcebergCatalogDetails
The information to update a Hadoop catalog used in the Iceberg connection.
UpdateHdfsConnectionDetails
The information to update a Hadoop Distributed File System Connection.
UpdateIcebergCatalogDetails
The information to update a catalog of given type used in an Iceberg connection.
UpdateIcebergCatalogDetailsModelConverter
UpdateIcebergConnectionDetails
The information to update an Iceberg Connection.
UpdateIcebergStorageDetails
The information to update a storage of given type used in an Iceberg connection.
UpdateIcebergStorageDetailsModelConverter
UpdateJavaMessageServiceConnectionDetails
The information to update a Java Message Service Connection.
UpdateKafkaConnectionDetails
The information to update a Kafka Connection.
UpdateKafkaSchemaRegistryConnectionDetails
The information to update Kafka (e.g. Confluent) Schema Registry Connection.
UpdateMaintenanceConfigurationDetails
Defines the maintenance configuration for update operation.
UpdateMaintenanceWindowDetails
Defines the maintenance window for update operation, when automatic actions can be performed.
UpdateMicrosoftFabricConnectionDetails
The information to update a Microsoft Fabric Connection.
UpdateMicrosoftSqlserverConnectionDetails
The information to update a Microsoft SQL Server Connection.
UpdateMongoDbConnectionDetails
The information to update a MongoDB Connection.
UpdateMysqlConnectionDetails
The information to update a MySQL Connection.
UpdateNessieIcebergCatalogDetails
The information to update a Nessie catalog used in the Iceberg connection.
UpdateOciObjectStorageConnectionDetails
The information to update a OCI Object Storage Connection.
UpdateOggDeploymentDetails
Deployment Details for updating an OggDeployment
UpdateOracleConnectionDetails
The information to update an Oracle Database Connection.
UpdateOracleNosqlConnectionDetails
The information to update a Oracle NoSQL Connection.
UpdatePipelineDetails
Information with which to update a pipeline.
UpdatePipelineDetailsModelConverter
UpdatePolarisIcebergCatalogDetails
The information to update a Polaris catalog used in the Iceberg connection.
UpdatePostgresqlConnectionDetails
The information to update a PostgreSQL Database Connection.
UpdateRedisConnectionDetails
The information to update a Redis Database Connection.
UpdateRestIcebergCatalogDetails
The information to update a Rest catalog used in the Iceberg connection.
UpdateSnowflakeConnectionDetails
The information to update a Snowflake Connection.
UpdateZeroEtlPipelineDetails
Information to update for an existing ZeroETL pipeline.
UpgradeDeploymentCurrentReleaseDetails
Definition of the additional attributes for a Current Release upgrade.
UpgradeDeploymentDetails
The information about the Upgrade for a Deployment.
UpgradeDeploymentDetailsModelConverter
UpgradeDeploymentSpecificReleaseDetails
Definition of the additional attributes for a Specific Release upgrade.
UpgradeDeploymentUpgradeDetails
The information about the upgrade for a deployment.
UpgradeDeploymentUpgradeDetailsModelConverter
WorkRequest
The API operations that create and configure GoldenGate resources do not take effect immediately. In these cases, the operation spawns an asynchronous workflow to fulfill the request. Work requests provide visibility into the status of these in-progress, long-running asynchronous workflows.
WorkRequestError
An error encountered while executing a work request.
WorkRequestLogEntry
A log message from the execution of a work request.
WorkRequestResource
A resource created or operated on by a work request.
ZeroEtlPipeline
The details of a ZeroETL pipeline.
ZeroEtlPipelineSummary
Summary of the ZeroETL pipeline.
Enums
ActionType
Possible types of actions.
AddResourceLockDetails.TypeEnum
AmazonKinesisConnection.TechnologyTypeEnum
AmazonRedshiftConnection.TechnologyTypeEnum
AmazonS3Connection.TechnologyTypeEnum
AmazonS3IcebergStorage.SchemeTypeEnum
AzureDataLakeStorageConnection.AuthenticationTypeEnum
AzureDataLakeStorageConnection.TechnologyTypeEnum
AzureSynapseConnection.TechnologyTypeEnum
BackupSchedule.FrequencyBackupScheduledEnum
CancelDeploymentBackupType
The deployment backup cancel type.
CancelDeploymentUpgradeType
The cancel type of deploymentUpgrade.
CancelSnoozeDeploymentUpgradeType
The cancel snooze type of deploymentUpgrade.
CertificateLifecycleState
Possible certificate lifecycle states.
Connection.LifecycleStateEnum
ConnectionAssignment.LifecycleStateEnum
ConnectionType
The connection type.
CreateBackupScheduleDetails.FrequencyBackupScheduledEnum
CreateDatabaseRegistrationDetails.SessionModeEnum
CredentialStore
The type of credential store for OGG.
DatabaseRegistration.SessionModeEnum
DatabaseRegistrationSummary.SessionModeEnum
DatabricksConnection.AuthenticationTypeEnum
DatabricksConnection.TechnologyTypeEnum
Day
Day of week for the maintenance.
Db2Connection.SecurityProtocolEnum
Db2Connection.TechnologyTypeEnum
DeploymentBackup.BackupSourceTypeEnum
DeploymentBackupSummary.BackupSourceTypeEnum
DeploymentBackupType
Possible backup types.
DeploymentCategory
The deployment category defines the broad separation of the deployment type into three categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.
DeploymentDiagnosticState
The Possible DeploymentDiagnosticState that applies to a Deployment Diagnostic collection.
DeploymentPeerSummary.LifecycleStateEnum
DeploymentPeerType
The Possible peer type for the deployment which is either local or regional.
DeploymentRole
The Possible role for the deployment which is either primary or standby.
DeploymentType
The deployment type.
DeploymentUpgradeLifecycleState
Possible deploymentUpgrade lifecycle states.
DeploymentUpgradeType
The deployment upgrade type.
DeploymentWalletOperationType
The Possible OperationType for the deployment wallet which is either IMPORT or EXPORT.
DeploymentWalletStatus
The possible states that applies to import/export operations of wallet from/to deployment.
ElasticsearchConnection.AuthenticationTypeEnum
ElasticsearchConnection.SecurityProtocolEnum
ElasticsearchConnection.TechnologyTypeEnum
EnvironmentType
Specifies whether the deployment is used in a production or development/testing environment.
GenericConnection.TechnologyTypeEnum
GoldenGateConnection.TechnologyTypeEnum
GoogleBigQueryConnection.TechnologyTypeEnum
GoogleCloudStorageConnection.TechnologyTypeEnum
GooglePubSubConnection.TechnologyTypeEnum
HdfsConnection.TechnologyTypeEnum
IcebergCatalogType
The catalog type.
IcebergConnection.TechnologyTypeEnum
IcebergStorageType
The storage type used in the Iceberg connection.
InitialDataLoad.IsInitialLoadEnum
InitialLoadAction
Action on existing tables, if Initial Load is true.
JavaMessageServiceConnection.AuthenticationTypeEnum
JavaMessageServiceConnection.SecurityProtocolEnum
JavaMessageServiceConnection.TechnologyTypeEnum
KafkaConnection.SecurityProtocolEnum
KafkaConnection.TechnologyTypeEnum
KafkaSchemaRegistryConnection.AuthenticationTypeEnum
KafkaSchemaRegistryConnection.TechnologyTypeEnum
LibraryType
The type of the library.
LicenseModel
The Oracle license model that applies to a Deployment.
LifecycleState
Possible lifecycle states.
LifecycleSubState
Possible lifecycle sub-states.
MaintenanceActionType
The of maintenance action.
MappingType
Mapping type for excluding or including source or target schemas or tables for replication.
MessageSummary.DeploymentMessageStatusEnum
MicrosoftFabricConnection.TechnologyTypeEnum
MicrosoftSqlserverConnection.SecurityProtocolEnum
MicrosoftSqlserverConnection.TechnologyTypeEnum
MongoDbConnection.SecurityProtocolEnum
MongoDbConnection.TechnologyTypeEnum
MysqlConnection.SecurityProtocolEnum
MysqlConnection.SslModeEnum
MysqlConnection.TechnologyTypeEnum
OciObjectStorageConnection.TechnologyTypeEnum
OperationStatus
Possible operation statuses.
OperationType
Possible operation types.
Deprecated value: GoldengateConnectionAssigmnentDelete
OracleConnection.AuthenticationModeEnum
OracleConnection.SessionModeEnum
OracleConnection.TechnologyTypeEnum
OracleNosqlConnection.TechnologyTypeEnum
Pipeline.LifecycleStateEnum
PipelineDiagnosticState
The possible states that applies to a pipeline diagnostics collection.
PipelineLifecycleSubState
Lifecycle substates of a pipeline.
PostgresqlConnection.SecurityProtocolEnum
PostgresqlConnection.SslModeEnum
PostgresqlConnection.TechnologyTypeEnum
ProcessOptions.ShouldRestartOnFailureEnum
ProcessOptions.StartUsingDefaultMappingEnum
ProcessStatusType
The process (Extract or Replicat) status type.
ProcessType
The process type (Extract or Replicat).
RecipeType
Possible recipe types for a pipeline. A recipe is a set of steps that run in a sequence.
RedisConnection.AuthenticationTypeEnum
RedisConnection.SecurityProtocolEnum
RedisConnection.TechnologyTypeEnum
RefreshConnectionType
The Connection external attribute refresh type.
ReleaseType
The type of release.
RemoveResourceLockDetails.TypeEnum
ReplicateDdlErrorAction
The action to take when a DDL error occurs during replication. Active only if Replicate schema changes (canReplicateSchemaChange=true) is selected.
ReplicateDmlErrorAction
The action to take when a DML error occurs during replication. Active only if Replicate schema changes (canReplicateSchemaChange=true) is selected.
ReplicateSchemaChange.CanReplicateSchemaChangeEnum
RescheduleDeploymentUpgradeType
The reschedule type of deploymentUpgrade.
ResourceLock.TypeEnum
RestoreDeploymentType
The deployment restore type.
RollbackDeploymentUpgradeType
The rollback type of deploymentUpgrade.
RoutingMethod
Determines the traffic flow of the connection
SeverityType
Message severity of GoldenGate APIs called for a step in a recipe. https://docs.oracle.com/en/middleware/goldengate/core/23/oggra/rest-endpoints.html
SnoozeDeploymentUpgradeType
The snooze type of deploymentUpgrade.
SnowflakeConnection.AuthenticationTypeEnum
SnowflakeConnection.TechnologyTypeEnum
SortOrder
Sort the list in ascending or descending order.
StartDeploymentType
The deployment start type.
StartPipelineType
The pipeline start type.
StepStatusType
Current status of a recipe step.
StopDeploymentType
The deployment stop type.
StopPipelineType
The pipeline stop type.
SupportedCapabilities
Specifies supported Capabilities or features supported by deployment type.
TechnologyType
The technology type.
TestConnectionAssignmentResult.ResultTypeEnum
TestConnectionAssignmentType
The type of the test to be performed.
TestPipelineConnectionResult.ResultTypeEnum
TestPipelineConnectionType
Type of test to perform on a pipeline's assigned connection.
UpdateBackupScheduleDetails.FrequencyBackupScheduledEnum
UpdateDatabaseRegistrationDetails.SessionModeEnum
UpgradeDeploymentType
The deployment upgrade type.
UpgradeDeploymentUpgradeType
The upgrade type of deploymentUpgrade.
WalletExistsDeploymentType
The deployment wallet exist type.