Namespace Oci.GoldengateService.Models
Classes
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.
AzureDataLakeStorageConnection
Represents the metadata of a Azure Data Lake Storage Connection.
AzureDataLakeStorageConnectionSummary
Summary of the Azure Data Lake Storage Connection.
AzureSynapseConnection
Represents the metadata of a Azure Synapse Analytics Connection.
AzureSynapseConnectionSummary
Summary of the Azure Synapse Analytics Connection.
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.
CollectDeploymentDiagnosticDetails
Details for collecting deployment diagnostic
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.
CreateAzureDataLakeStorageConnectionDetails
The information about a new Azure Data Lake Storage Connection.
CreateAzureSynapseConnectionDetails
The information about a new Azure Synapse Analytics Connection.
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.
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.
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.
CreateHdfsConnectionDetails
The information about a new Hadoop Distributed File System Connection.
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.
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.
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.
CreatePostgresqlConnectionDetails
The information about a new PostgreSQL Connection.
CreateRedisConnectionDetails
The information about a new Redis Connection.
CreateSnowflakeConnectionDetails
The information about a new Snowflake Connection.
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.
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 .
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.
DefaultStopDeploymentDetails
Definition of the additional attributes for default deployment stop.
DefaultTestConnectionAssignmentDetails
Definition of the additional attributes for default test of assigned connection.
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.
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.
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.
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.
HdfsConnection
Represents the metadata of a Hadoop Distributed File System Connection.
HdfsConnectionSummary
Summary of the Hadoop Distributed File System Connection.
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.
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.
MessageSummary
Deployment message Summary.
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.
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.
PostgresqlConnection
Represents the metadata of a PostgreSQL Database Connection.
PostgresqlConnectionSummary
Summary of the PostgreSQL Database Connection.
RedisConnection
Represents the metadata of a Redis Database Connection.
RedisConnectionSummary
Summary of the Redis Database Connection.
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.
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.
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.
StartDeploymentDetails
The information about the Start for a Deployment.
StartDeploymentDetailsModelConverter
StopDeploymentDetails
The information about the Stop for a Deployment.
StopDeploymentDetailsModelConverter
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.
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.
UpdateAzureDataLakeStorageConnectionDetails
The information to update a Azure Data Lake Storage Connection.
UpdateAzureSynapseConnectionDetails
The information to update a Azure Synapse Analytics Connection.
UpdateConnectionDetails
The information to update a Connection.
UpdateConnectionDetailsModelConverter
UpdateDatabaseRegistrationDetails
The information to update a DatabaseRegistration.
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.
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.
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.
UpdateHdfsConnectionDetails
The information to update a Hadoop Distributed File System Connection.
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.
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.
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.
UpdatePostgresqlConnectionDetails
The information to update a PostgreSQL Database Connection.
UpdateRedisConnectionDetails
The information to update a Redis Database Connection.
UpdateSnowflakeConnectionDetails
The information to update a Snowflake Connection.
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.
Enums
ActionType
Possible types of actions.
AddResourceLockDetails.TypeEnum
AmazonKinesisConnection.TechnologyTypeEnum
AmazonRedshiftConnection.TechnologyTypeEnum
AmazonS3Connection.TechnologyTypeEnum
AzureDataLakeStorageConnection.AuthenticationTypeEnum
AzureDataLakeStorageConnection.TechnologyTypeEnum
AzureSynapseConnection.TechnologyTypeEnum
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.
CreateDatabaseRegistrationDetails.SessionModeEnum
CredentialStore
The type of credential store for OGG.
DatabaseRegistration.SessionModeEnum
DatabaseRegistrationSummary.SessionModeEnum
Day
Day of week for the maintenance.
Db2Connection.SecurityProtocolEnum
Db2Connection.TechnologyTypeEnum
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.
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
HdfsConnection.TechnologyTypeEnum
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.
MessageSummary.DeploymentMessageStatusEnum
MicrosoftSqlserverConnection.SecurityProtocolEnum
MicrosoftSqlserverConnection.TechnologyTypeEnum
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
PostgresqlConnection.SecurityProtocolEnum
PostgresqlConnection.SslModeEnum
PostgresqlConnection.TechnologyTypeEnum
RedisConnection.AuthenticationTypeEnum
RedisConnection.SecurityProtocolEnum
RedisConnection.TechnologyTypeEnum
ReleaseType
The type of release.
RemoveResourceLockDetails.TypeEnum
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
SnoozeDeploymentUpgradeType
The snooze type of deploymentUpgrade.
SnowflakeConnection.AuthenticationTypeEnum
SnowflakeConnection.TechnologyTypeEnum
SortOrder
Sort the list in ascending or descending order.
StartDeploymentType
The deployment start type.
StopDeploymentType
The deployment stop type.
TechnologyType
The technology type.
TestConnectionAssignmentResult.ResultTypeEnum
TestConnectionAssignmentType
The type of the test to be performed.
UpdateDatabaseRegistrationDetails.SessionModeEnum
UpgradeDeploymentType
The deployment upgrade type.
UpgradeDeploymentUpgradeType
The upgrade type of deploymentUpgrade.
WalletExistsDeploymentType
The deployment wallet exist type.