The identity and technical contract details declared by the specification.
UpdateMaintenanceWindowDetails
object
Defines the maintenance window for update operation, when automatic actions can be performed.
2 properties
2 required
ChangeDeploymentBackupCompartmentDetails
object
The new compartment for a DeploymentBackup.
1 property
1 required
CancelSnoozeDeploymentUpgradeDetails
object
The information about snooze canceling.
1 property
1 required
PipelineSummary
object
Summary details of the pipeline.
20 properties
12 required
DisasterRecoveryPrecheckResult
object
A single precheck result.
8 properties
7 required
ChangeConnectionSubscriptionDetails
The configuration details for associating the GoldenGate connection resource with a different subscription.
ClonePipelineDetails
object
Details for a pipeline clone.
8 properties
4 required
CollectPipelineDiagnosticDetails
object
Details for collecting pipeline diagnostics
3 properties
2 required
DisasterRecoveryPrecheckReport
object
DR precheck result for standby peer in the specified placement (availabilityDomain and faultDomain).
4 properties
4 required
PipelineSchemaTableCollection
object
List of source or target schema tables of a pipeline's assigned connection.
3 properties
1 required
DeploymentUpgradeSummary
object
Summary of the Deployment Upgrade.
29 properties
4 required
PipelineSchemaCollection
object
The list of schemas present in the source/target connection database of a pipeline.
1 property
1 required
GroupToRolesMappingDetails
object
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 dep…
4 properties
1 required
ResourceLock
object
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.…
4 properties
1 required
ImportDeploymentWalletDetails
object
Metadata required to import wallet to deployment
6 properties
2 required
PipelineRunningProcessSummary
object
Each replication process and their summary details.
5 properties
5 required
CreateDeploymentBackupDetails
object
The information about a new DeploymentBackup.
10 properties
6 required
RemoveResourceLockDetails
object
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 reso…
1 property
1 required
SnoozeDeploymentUpgradeDetails
object
The information about the snooze for a deployment.
1 property
1 required
DeploymentCollection
object
A list of Deployments.
1 property
1 required
DeploymentVersionCollection
object
The list of DeploymentVersionSummary objects.
1 property
1 required
CreateDatabaseRegistrationDetails
object
The information about a new DatabaseRegistration.
18 properties
6 required
DeploymentPeerCollection
object
A list of DeploymentPeers.
1 property
1 required
DatabaseRegistrationSummary
object
Summary of the DatabaseRegistration.
19 properties
4 required
StopPipelineDetails
object
Details for a pipeline stop.
1 property
1 required
DeploymentEnvironmentSummary
object
The metadata specific to a production or development/testing environment.
10 properties
9 required
CreateConnectionDetails
object
The information about a new Connection.
16 properties
3 required
TestConnectionAssignmentDetails
object
The information about testing the assigned connection.
1 property
1 required
PipelineSchemaTableSummary
object
Summary of source or target schema tables of a pipeline's assigned connection. 1. If there is no explicit mapping defined for the pipeline then only matched so…
2 properties
2 required
SwitchoverDeploymentPeerDetails
object
The information about switching to deployment peer.
3 properties
2 required
ChangeSubscriptionDetails
object
The configuration details for associating the resource with a different subscription.
2 properties
StartPipelineDetails
object
Details with which to start a pipeline.
1 property
1 required
DeploymentUpgradeCollection
object
A list of Deployment Upgrades.
1 property
1 required
UpgradeDeploymentDetails
object
The information about the Upgrade for a Deployment.
1 property
1 required
CreateMaintenanceWindowDetails
object
Defines the maintenance window for create operation, when automatic actions can be performed.
2 properties
2 required
UpdateMaintenanceConfigurationDetails
object
Defines the maintenance configuration for update operation.
5 properties
ChangeDeploymentSubscriptionDetails
The configuration details for associating the GoldenGate deployment resource with a different subscription.
DeploymentWalletExistsDetails
object
The information to check if a wallet is present in the Deployment.
1 property
1 required
Certificate
object
Certificate data.
20 properties
20 required
ExportDeploymentWalletDetails
object
Metadata required to export wallet from deployment
5 properties
3 required
MaintenanceConfiguration
object
Attributes for configuring automatic deployment maintenance.
5 properties
4 required
TrailFileSummary
object
Summary of the TrailFiles.
9 properties
1 required
WorkRequestError
object
An error encountered while executing a work request.
3 properties
3 required
UpdateBackupScheduleDetails
object
Defines the backup schedule details for update operation.
6 properties
UpdatePipelineDetails
string
Information with which to update a pipeline.
9 properties
DeploymentBackupCollection
object
A list of DeploymentBackups.
1 property
1 required
UpdateDeploymentBackupDetails
object
The information to use to update a Deployment Backup.
2 properties
TechnologyType
string
The technology type.
DeploymentTypeCollection
object
The list of DeploymentTypeDescriptor objects.
1 property
1 required
DeploymentBackup
object
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 dep…
24 properties
6 required
TrailFileCollection
object
A list of TrailFiles.
2 properties
2 required
ChangeConnectionCompartmentDetails
object
The new compartment for a Connection.
1 property
1 required
CreateConnectionAssignmentDetails
object
The information about a new Connection Assignment.
2 properties
2 required
ConnectionAssignmentCollection
object
List of connection summary objects.
1 property
1 required
LicenseModel
string
The Oracle license model that applies to a Deployment.
CreateOggDeploymentDetails
object
Deployment Data for creating an OggDeployment
11 properties
DatabaseRegistration
object
Represents the metadata description of a database used by deployments in the same compartment.
25 properties
7 required
Pipeline
object
Represents the metadata details of a pipeline in the same compartment.
22 properties
12 required
RefreshConnectionDetails
object
The information about the Refresh Connection external attributes.
1 property
1 required
CreateMaintenanceConfigurationDetails
object
Defines the maintenance configuration for create operation.
5 properties
WorkRequestLogEntry
object
A log message from the execution of a work request.
2 properties
2 required
TestPipelineConnectionError
object
The error returned when a pipeline connection fails to connect.
DeploymentPlacementInfo
object
Specifies a deployment placement with explicit availability and fault domain specification.
2 properties
2 required
PipelineDiagnosticData
object
Information regarding the pipeline diagnostic collection
5 properties
4 required
UpdateOggDeploymentDetails
object
Deployment Details for updating an OggDeployment
9 properties
RecipeSummary
object
The list of recipe details to create pipelines.
6 properties
5 required
SourcePipelineConnectionDetails
object
The source connection details for creating a pipeline.
1 property
1 required
CancelDeploymentBackupDetails
object
The information about the Cancel for a DeploymentBackup.
1 property
1 required
CertificateCollection
object
A list of Certificates.
1 property
1 required
OggDeployment
object
Deployment Data for an OggDeployment
9 properties
2 required
DeploymentPlacementDetails
object
Specifies a possible deployment placement. Placement either explicitly specifies the availability and fault domain, or it is partial and lets Oracle to find an…
2 properties
TrailSequenceCollection
object
A list of TrailSequences.
2 properties
2 required
MigrateConnectionDetails
object
The information about the Migrate Connection.
1 property
1 required
AddResourceLockDetails
object
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 resourc…
2 properties
1 required
TestPipelineConnectionResult
object
Result of the connectivity test performed on a pipeline's assigned connection.
2 properties
1 required
CopyDeploymentBackupDetails
object
The information about the copy for a Deployment Backup.
4 properties
2 required
GenerateLibraryUrlDetails
object
The information about generating the library URL.
1 property
1 required
PausePipelineDetails
object
Details for a pipeline pause.
1 property
1 required
ConnectionAssignmentSummary
object
Summary of the Connection Assignment.
9 properties
9 required
TestPipelineConnectionDetails
object
Details about testing the pipeline's assigned connection.
1 property
1 required
UpdateDeploymentDetails
object
The information to use to update a Deployment.
21 properties
DeploymentWalletsOperationCollection
object
A list of deployment wallets operations.
1 property
1 required
PipelineInitializationSteps
object
The steps and their progress, based on the recipe type.
1 property
1 required
WorkRequest
object
The API operations that create and configure GoldenGate resources do not take effect immediately. In these cases, the operation spawns an asynchronous workflow…
9 properties
7 required
PipelineRunningProcessCollection
object
The complete replication process and its details.
1 property
1 required
RescheduleDeploymentUpgradeDetails
object
The information about canceling.
1 property
1 required
MaintenanceWindow
object
Defines the maintenance window, when automatic actions can be performed.
2 properties
2 required
RemoveDeploymentLocalPeerDetails
object
The information about removing a deployment peer.
2 properties
2 required
DeploymentSummary
object
Summary of the Deployment.
37 properties
6 required
UpdateDatabaseRegistrationDetails
object
The information to update a DatabaseRegistration.
11 properties
TestConnectionAssignmentError
object
Error Information.
4 properties
2 required
AddDeploymentLocalPeerDetails
object
The information about adding a deployment peer in list.
2 properties
ChangePipelineCompartmentDetails
object
The new compartment for a Pipeline.
1 property
1 required
TrailSequenceSummary
object
Summary of the TrailSequences.
4 properties
1 required
DeploymentWalletsOperationSummary
object
Summary of the deployment wallets operations.
6 properties
5 required
DeploymentVersionSummary
object
The summary data of a specific deployment version.
6 properties
2 required
ConnectionAssignment
object
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 deplo…
9 properties
8 required
DeploymentUpgrade
object
A container for your OCI GoldenGate Upgrade information.
29 properties
4 required
CreateCertificateDetails
object
The information about a new Certificates.
2 properties
2 required
WorkRequestResource
object
A resource created or operated on by a work request.
4 properties
3 required
Deployment
object
A container for your OCI GoldenGate resources, such as the OCI GoldenGate deployment console.
57 properties
8 required
MessageSummary
object
Deployment message Summary.
3 properties
3 required
DeploymentWalletExistsResponseDetails
object
Indicates whether the wallet exists in the deployment container
1 property
1 required
StepMessage
object
Contents of a step message.
4 properties
4 required
UpdateConnectionDetails
object
The information to update a Connection.
12 properties
DeploymentDiagnosticData
object
Information regarding the deployment diagnostic collection
6 properties
4 required
CertificateSummary
object
Summary of the Certificates.
6 properties
6 required
IngressIpDetails
object
Private Endpoint IP Addresses created in the customer's subnet. GoldenGate service will use these ingress IP addresses to send all specific requests initiated…
1 property
1 required
ConnectionCollection
object
List of connection summary objects.
1 property
1 required
DeploymentTypeSummary
object
The meta-data specific on particular deployment type represented by deploymentType field. Deprecated properties: sourceTechnologies and targetTechnologies are…
11 properties
3 required
PipelineCollection
object
List of pipeline summary objects.
1 property
1 required
DeploymentEnvironmentCollection
object
The list of DeploymentEnvironmentDescriptor objects.
1 property
1 required
UpdateGroupToRolesMappingDetails
object
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 dep…
4 properties
DeploymentBackupSummary
object
The summary of the Backup.
24 properties
6 required
AiModelAuthType
string
Authentication type used by the AI model connection.
AiModelCollection
object
Collection of AI models currently known by GoldenGate for the specified provider.
1 property
1 required
RecipeSummaryCollection
object
The list of Recipe objects.
1 property
1 required
StartDeploymentDetails
object
The information about the Start for a Deployment.
1 property
1 required
LibraryUrl
object
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 connect…
1 property
1 required
RollbackDeploymentUpgradeDetails
object
The information about the rollback of an upgrade.
1 property
1 required
CollectDeploymentDiagnosticDetails
object
Details for collecting deployment diagnostic
5 properties
3 required
BackupSchedule
object
Defines the schedule of the deployment backup.
6 properties
6 required
CreateDeploymentDetails
object
The information about a new Deployment.
31 properties
3 required
PipelineSchemaSummary
object
List of source and target schemas of a pipeline's assigned connection. 1. If there is no explicit mapping defined for the pipeline then only matched source and…
2 properties
2 required
Connection
object
Represents the metadata description of a connection used by deployments in the same compartment.
23 properties
7 required
TestConnectionAssignmentResult
object
The result of the connectivity test performed between the GoldenGate deployment and the associated database / service. The 'error' property is deprecated and w…
3 properties
1 required
CreateBackupScheduleDetails
object
Defines the backup schedule details for create operation.
6 properties
6 required
TargetPipelineConnectionDetails
object
The target connection details for creating a pipeline.
1 property
1 required
GenerateDisasterRecoveryPrecheckReportDetails
object
Metadata required to submit to generate a DR precheck report.
2 properties
2 required
UpgradeDeploymentUpgradeDetails
object
The information about the upgrade for a deployment.
1 property
1 required
AiProviderSummary
object
Summary details of an AI provider and its supported models.
6 properties
5 required
StopDeploymentDetails
object
The information about the Stop for a Deployment.
1 property
1 required
ChangeDeploymentCompartmentDetails
object
The new compartment for a Deployment.
1 property
1 required
AiProviderCollection
object
Collection of AI providers supported by GoldenGate.
1 property
1 required
DatabaseRegistrationCollection
object
A list of DatabaseRegistrations.
1 property
1 required
ConnectionSummary
object
Summary of the Connection.
23 properties
7 required
RestoreDeploymentDetails
object
The information about the Restore for a Deployment.
1 property
1 required
ChangeDatabaseRegistrationCompartmentDetails
object
The new compartment for a DatabaseRegistration.
1 property
1 required
Error
object
Error information.
2 properties
2 required
AiModelSummary
object
Summary details of an AI model supported by a provider.
4 properties
4 required
DeploymentPeerSummary
object
The summary of the deployment Peer.
16 properties
11 required
CancelDeploymentUpgradeDetails
object
The information about canceling.
1 property
1 required
PipelineInitializationStep
object
The step and its progress based on the recipe type.
6 properties
5 required
DeploymentMessageCollection
object
A list of DeploymentMessages.
1 property
1 required
CreatePipelineDetails
object
Details with which to create a pipeline.
13 properties
6 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle publishes across the network.