Show / Hide Table of Contents

Namespace Oci.DatabasemigrationService.Models

Classes

ADBDedicatedAutoCreateTablespaceDetails

Auto create tablespace settings that are valid for Dedicated Autonomous Databases.

ADBDedicatedRemapTargetTablespaceDetails

Remap tablespace settings that are valid for Dedicated Autonomous Databases.

ADBServerlesTablespaceDetails

Migration tablespace settings valid for Autonomous Database Serverless target type using remap feature.

AdminCredentials

Database Administrator Credentials details.

AdvisorReport

Premigration Advisor report details.

AdvisorReportBucketDetails

Details to access Premigration Advisor report in the specified Object Storage bucket.

AdvisorReportLocationDetails

Details to access Premigration Advisor report.

ChangeConnectionCompartmentDetails

Details for changing the compartment for a Connection.

ChangeMigrationCompartmentDetails

Details pertaining to change of a migration's compartment.

CloneMigrationDetails

Customizable details when performing cloning of a migration.

CloneMigrationDetailsModelConverter

Connection

Represents the common details required for creating a new connection.

ConnectionCollection

Array of connection summary objects.

ConnectionModelConverter

ConnectionSummary

Represents the parameters common for all connections in list operation.

ConnectionSummaryModelConverter

CreateADBDedicatedAutoCreateTablespaceDetails

Auto create tablespace settings that are valid for Dedicated Autonomous Databases.

CreateADBDedicatedRemapTargetTablespaceDetails

Remap tablespace settings that are valid for Dedicated Autonomous Databases.

CreateADBServerlesTablespaceDetails

Migration tablespace settings valid for Autonomous Database Serverless target type using remap feature.

CreateAdminCredentials

Database Administrator Credentials details.

CreateConnectionDetails

The information about a new Connection.

CreateConnectionDetailsModelConverter

CreateCurlTransferDetails

Optional properties for Curl-based dump transfer in source or target host.

CreateDataPumpParameters

Optional parameters for Data Pump Export and Import.

CreateDirectoryObject

Directory object details, used to define either import or export directory objects in Data Pump Settings. Import directory is required for Non-Autonomous target connections. If specified for an autonomous target, it will show an error. Export directory will error if there are database link details specified.

CreateExtract

Parameters for GoldenGate Extract processes.

CreateGoldenGateHubDetails

Details about Oracle GoldenGate Microservices.

CreateHostDumpTransferDetails

Optional additional properties for dump transfer in source or target host. Default kind is CURL.

CreateHostDumpTransferDetailsModelConverter

CreateMigrationDetails

Common Migration details.

CreateMigrationDetailsModelConverter

CreateMySqlAdvisorSettings

Optional Pre-Migration advisor settings.

CreateMySqlDataTransferMediumDetails

Optional additional properties for data transfer.

CreateMySqlDataTransferMediumDetailsModelConverter

CreateMySqlGgsDeploymentDetails

Optional settings for Oracle GoldenGate processes

CreateMySqlInitialLoadSettings

Optional dump settings

CreateMySqlMigrationDetails

Create Migration resource parameters.

CreateMySqlObjectStorageDataTransferMediumDetails

OCI Object Storage bucket will be used to store dump files for the migration.

CreateMysqlConnectionDetails

The information about a new MySQL Connection.

CreateNonADBAutoCreateTablespaceDetails

Migration tablespace settings valid for NON-ADB target type using auto create feature.

CreateNonADBRemapTablespaceDetails

Migration tablespace settings valid for NON-ADB target type using remap feature.

CreateObjectStoreBucket

In lieu of a network database link, OCI Object Storage bucket will be used to store Data Pump dump files for the migration. Additionally, it can be specified alongside a database link data transfer medium.

CreateOciCliDumpTransferDetails

Optional dump transfer details for OCI-CLI-based dump transfer in source or target host.

CreateOracleAdvisorSettings

Optional Pre-Migration advisor settings.

CreateOracleAwsS3DataTransferMediumDetails

AWS S3 bucket details used for source Connection resources with RDS_ORACLE type. Only supported for source Connection resources with RDS_ORACLE type.

CreateOracleConnectionDetails

The information about a new Oracle Database Connection.

CreateOracleDataTransferMediumDetails

Optional additional properties for data transfer.

CreateOracleDataTransferMediumDetailsModelConverter

CreateOracleDbLinkDataTransferMediumDetails

Optional details for creating a network database link from OCI database to on-premise database.

CreateOracleGgsDeploymentDetails

Optional settings for Oracle GoldenGate processes

CreateOracleInitialLoadSettings

Optional settings for Data Pump Export and Import jobs

CreateOracleMigrationDetails

Create Migration resource parameters.

CreateOracleNfsDataTransferMediumDetails

OCI Object Storage bucket will be used to store Data Pump dump files for the migration.

CreateOracleObjectStorageDataTransferMediumDetails

OCI Object Storage bucket will be used to store Data Pump dump files for the migration.

CreateParameterFileVersionDetails

Details about a specific ParameterFileVersion

CreateReplicat

Parameters for GoldenGate Replicat processes.

CreateTargetTypeTablespaceDetails

Migration tablespace settings.

CreateTargetTypeTablespaceDetailsModelConverter

CurlTransferDetails

Optional properties for Curl-based dump transfer in source or target host.

DataPumpParameters

Optional parameters for Data Pump Export and Import.

DiagnosticsResult

Result from Database Connection Diagnostic action.

DirectoryObject

Directory object details, used to define either import or export directory objects in Data Pump Settings.

ExcludedObjectSummary

Excluded object summary line.

ExcludedObjectSummaryCollection

Results of a Job's Exclude objects output listing. Contains ExcludedObjectSummary items.

Extract

Parameters for Extract processes.

GgsDeployment

Details about Oracle GoldenGate GGS Deployment.

GoldenGateHubDetails

Details about Oracle GoldenGate Microservices.

HostDumpTransferDetails

Optional additional properties for dump transfer in source or target host. Default kind is CURL.

HostDumpTransferDetailsModelConverter

IngressIpDetails

Private Endpoint IP Addresses created in the customer's subnet.

Job

Results of a Database Connection search. Contains DatabaseConnectionSummary items.

JobCollection

Results of a Job search. Contains JobSummary items.

JobOutputSummary

Job output summary line.

JobOutputSummaryCollection

Results of a Job output listing. Contains JobOutputSummary items.

JobSummary

Job description

LogLocationBucketDetails

Details to access log file in the specified Object Storage bucket, if any.

MetadataRemap

Defines remapping to be applied to objects as they are processed. Refer to METADATA_REMAP Procedure

Migration

Migration resource

MigrationCollection

Results of a Migration search. Contains MigrationSummary items.

MigrationJobProgressResource

Progress details of a Migration Job.

MigrationJobProgressSummary

Summary of the progress of a Migration Job.

MigrationModelConverter

MigrationObjectCollection

Common Migration Objects collection.

MigrationObjectCollectionModelConverter

MigrationObjectTypeSummary

Migration Object Type

MigrationObjectTypeSummaryCollection

Results of a Migration Object Type listing. Contains MigrationObjectTypeSummary items.

MigrationParameterBase

Migration parameter base object.

MigrationParameterDetails

Migration parameter details object.

MigrationParameterSummary

Migration parameter response object.

MigrationParameterSummaryCollection

List of Migration Parameter Summary objects.

MigrationPhaseCollection

Results of a Migration Phase search. Contains a collection of valid ODMS Job Phases.

MigrationPhaseSummary

Migration Phase Summary of details.

MigrationSummary

Migration resource

MigrationSummaryModelConverter

MySqlAdvisorSettings

Details about Advisor Settings.

MySqlCloneMigrationDetails

MySQL Clone Migration Summary

MySqlDataTransferMediumDetails

Optional additional properties for data transfer.

MySqlDataTransferMediumDetailsModelConverter

MySqlDatabaseObject

Database objects to include or exclude from migration

MySqlDatabaseObjectSummary

Database objects to include or exclude from migration

MySqlGgsDeploymentDetails

Optional settings for Oracle GoldenGate processes

MySqlInitialLoadSettings

Optional dump settings

MySqlMigration

MySQL Migration resource

MySqlMigrationObjectCollection

Lists the database objects that participate in this migration.

MySqlMigrationSummary

MySQL Migration Summary

MySqlObjectStorageDataTransferMediumDetails

OCI Object Storage bucket will be used to store dump files for the migration.

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.

NonADBAutoCreateTablespaceDetails

Migration tablespace settings valid for NON-ADB target type using auto create feature.

NonADBRemapTablespaceDetails

Migration tablespace settings valid for NON-ADB target type using remap feature

ObjectStoreBucket

In lieu of a network database link, OCI Object Storage bucket will be used to store Data Pump dump files for the migration. Additionally, it can be specified alongside a database link data transfer medium.

OciCliDumpTransferDetails

Optional dump transfer details for OCI-CLI-based dump transfer in source or target host.

OracleAdvisorSettings

Details about Oracle Advisor Settings.

OracleAwsS3DataTransferMediumDetails

AWS S3 bucket details used for source Connection resources with RDS_ORACLE type. Only supported for source Connection resources with RDS_ORACLE type.

OracleCloneMigrationDetails

Oracle Clone Migration Summary

OracleConnection

Represents the metadata of an Oracle Database Connection.

OracleConnectionSummary

Summary of the Oracle Connection.

OracleDataTransferMediumDetails

Optional additional properties for data transfer.

OracleDataTransferMediumDetailsModelConverter

OracleDatabaseObject

Database objects to include or exclude from migration

OracleDatabaseObjectSummary

Database objects to include or exclude from migration

OracleDbLinkDataTransferMediumDetails

Optional details for creating a network database link from OCI database to on-premise database.

OracleGgsDeploymentDetails

Optional settings for Oracle GoldenGate processes

OracleInitialLoadSettings

Optional settings for Data Pump Export and Import jobs

OracleMigration

Oracle Migration resource

OracleMigrationObjectCollection

Database objects to migrate.

OracleMigrationSummary

Oracle Migration Summary

OracleNfsDataTransferMediumDetails

OCI Object Storage bucket will be used to store Data Pump dump files for the migration.

OracleObjectStorageDataTransferMediumDetails

OCI Object Storage bucket will be used to store Data Pump dump files for the migration.

ParameterFileVersion

Details of a parameter file

ParameterFileVersionCollection

The result of the request for Parameter Files. It contains a collection of ParameterFileVersionSummary

ParameterFileVersionSummary

Details of a parameter file

PhaseExtractEntry

Job phase extract message.

PhaseStatus

Job phase status details.

Replicat

Parameters for Replicat processes.

ResultError

Error Information.

ResumeJobDetails

Parameters to specify to resume a Migration Job.

StartMigrationDetails

Parameters to specify to a Migration job operation.

TargetTypeTablespaceDetails

Migration tablespace settings.

TargetTypeTablespaceDetailsModelConverter

UnsupportedDatabaseObject

Database objects to exclude from migration

UpdateADBDedicatedAutoCreateTablespaceDetails

Auto create tablespace settings that are valid for Dedicated Autonomous Databases.

UpdateADBDedicatedRemapTargetTablespaceDetails

Remap tablespace settings that are valid for Dedicated Autonomous Databases.

UpdateADBServerlesTablespaceDetails

Migration tablespace settings valid for Autonomous Database Serverless target type using remap feature.

UpdateAdminCredentials

Database Administrator Credentials details. An empty object would result in the removal of the stored details.

UpdateConnectionDetails

The information to update a Connection.

UpdateConnectionDetailsModelConverter

UpdateCurlTransferDetails

Optional properties for Curl-based dump transfer in source or target host.

UpdateDataPumpParameters

Optional parameters for Data Pump Export and Import. If an empty object is specified, the stored Data Pump Parameter details will be removed.

UpdateDirectoryObject

Directory object details, used to define either import or export directory objects in Data Pump Settings. Import directory is required for Non-Autonomous target connections. If specified for an autonomous target, it will show an error. Export directory will error if there are database link details specified. If an empty object is specified, the stored Directory Object details will be removed.

UpdateExtract

Parameters for Extract processes. If an empty object is specified, the stored Extract details will be removed.

UpdateGoldenGateHubDetails

Details about Oracle GoldenGate Microservices.

UpdateHostDumpTransferDetails

Optional additional properties for dump transfer in source or target host. Default kind is CURL.

UpdateHostDumpTransferDetailsModelConverter

UpdateJobDetails

Update Job Details

UpdateMigrationDetails

Common Update Migration details.

UpdateMigrationDetailsModelConverter

UpdateMySqlAdvisorSettings

Optional Pre-Migration advisor settings.

UpdateMySqlDataTransferMediumDetails

Optional additional properties for data transfer.

UpdateMySqlDataTransferMediumDetailsModelConverter

UpdateMySqlGgsDeploymentDetails

Optional settings for Oracle GoldenGate processes

UpdateMySqlInitialLoadSettings

Optional dump settings

UpdateMySqlMigrationDetails

Update Migration parameters.

UpdateMySqlObjectStorageDataTransferMediumDetails

OCI Object Storage bucket will be used to store dump files for the migration.

UpdateMysqlConnectionDetails

The information to update a MySQL Connection.

UpdateNonADBAutoCreateTablespaceDetails

Migration tablespace settings valid for NON-ADB target type using auto create feature.

UpdateNonADBRemapTablespaceDetails

Migration tablespace settings valid for NON-ADB target type using remap feature.

UpdateObjectStoreBucket

OCI Object Storage bucket details.

UpdateOciCliDumpTransferDetails

Optional dump transfer details for OCI-CLI-based dump transfer in source or target host.

UpdateOracleAdvisorSettings

Optional Pre-Migration advisor settings.

UpdateOracleAwsS3DataTransferMediumDetails

AWS S3 bucket details used for source Connection resources with RDS_ORACLE type. Only supported for source Connection resources with RDS_ORACLE type.

UpdateOracleConnectionDetails

The information to update an Oracle Database Connection.

UpdateOracleDataTransferMediumDetails

Optional additional properties for data transfer.

UpdateOracleDataTransferMediumDetailsModelConverter

UpdateOracleDbLinkDataTransferMediumDetails

Optional details for creating a network database link from OCI database to on-premise database.

UpdateOracleGgsDeploymentDetails

Optional settings for Oracle GoldenGate processes

UpdateOracleInitialLoadSettings

Optional settings for Data Pump Export and Import jobs

UpdateOracleMigrationDetails

Create Migration resource parameters.

UpdateOracleNfsDataTransferMediumDetails

OCI Object Storage bucket will be used to store Data Pump dump files for the migration.

UpdateOracleObjectStorageDataTransferMediumDetails

OCI Object Storage bucket will be used to store Data Pump dump files for the migration.

UpdateReplicat

Parameters for Replicat processes. If an empty object is specified, the stored Replicat details will be removed.

UpdateTargetDefaultsAutoCreateTablespaceDetails

Migration tablespace settings valid for TARGET_DEFAULTS_AUTOCREATE target type. The service will compute the targetType that corresponds to the targetDatabaseConnectionId type, and set the corresponding default values. When target type is ADB_D or NON_ADB the default will be set to auto-create feature ADB_D_AUTOCREATE or NON_ADB_AUTOCREATE.

UpdateTargetDefaultsRemapTablespaceDetails

Migration tablespace settings valid for TARGET_DEFAULTS_REMAP target type. The service will compute the targetType that corresponds to the targetDatabaseConnectionId type, and set the corresponding default values. When target type is ADB_S, ADB_D or NON_ADB the default will be set to remap feature ADB_S_REMAP, ADB_D_REMAP or NON_ADB_REMAP.

UpdateTargetTypeTablespaceDetails

Migration tablespace settings.

UpdateTargetTypeTablespaceDetailsModelConverter

WorkRequest

An asynchronous work request.

WorkRequestCollection

Results of a Work Request search. Contains WorkRequestSummary items.

WorkRequestError

An error encountered while executing an operation that is tracked by a work request.

WorkRequestErrorCollection

Results of a Work Request search. Contains WorkRequestError items.

WorkRequestLogEntry

A log message from executing an operation that is tracked by a work request.

WorkRequestLogEntryCollection

Results of a Work Request search. Contains WorkRequestLogEntry items.

WorkRequestResource

A resource that is created or operated on by an asynchronous operation that is tracked by a work request.

WorkRequestSummary

A summary of the status of a work request.

Enums

ADBServerlesTablespaceDetails.RemapTargetEnum

AdvancedParameterDataTypes

Advanced Parameter Data types.

AdvisorResults

Pre-Migration advisor result.

CompatibilityOption

Compatibility option. FORCE_INNODB - Change CREATE TABLE statements to use the InnoDB storage engine for any tables that do not already use it. SKIP_INVALID_ACCOUNTS - Remove user accounts created with external authentication plugins that are not supported in MySQL HeatWave Service. STRIP_DEFINERS - Remove the DEFINER clause from views, routines, events, and triggers, so these objects are created with the default definer. STRIP_RESTRICTED_GRANTS - Remove specific privileges that are restricted by MySQL HeatWave Service from GRANT statements, so users and their roles cannot be given these privileges STRIP_TABLESPACES - Remove the TABLESPACE clause from CREATE TABLE statements, so all tables are created in their default tablespaces. IGNORE_WILDCARD_GRANTS - Ignore errors from grants on schemas with wildcards, which are interpreted differently in systems where the partial_revokes system variable is enabled. STRIP_INVALID_GRANTS - Strip grant statements which would fail when users are loaded. Such as grants referring to a specific routine which does not exist.

Connection.LifecycleStateEnum

ConnectionType

The type of database connection. Example: ORACLE or MYSQL

CreateHostDumpTransferDetails.KindEnum

CreateMySqlDataTransferMediumDetails.TypeEnum

CreateOracleDataTransferMediumDetails.TypeEnum

DataPumpEstimate

Estimate size of dumps that will be generated.

DataPumpExcludeParameters

Supported Import/Export exclude parameters

DataPumpTableExistsAction

IMPORT: Specifies the action to be performed when data is loaded into a preexisting table, if unspecified ZDM will apply default value.

DataPumpTablespaceBlockSizesInKb

Size of Oracle database blocks in KB.

DatabaseCombination

The database combination.

ExtractPerformanceProfile

GoldenGate Extract performance profile

HandleGrantErrors

The action taken in the event of errors related to GRANT or REVOKE errors. ABORT - (default) stops the load process and displays an error. DROP_ACCOUNT - deletes the account and continues the load process. IGNORE - ignores the error and continues the load process.

HostDumpTransferDetails.KindEnum

JobLifecycleStates

Possible lifecycle states.

JobModeMySql

job mode.

JobModeOracle

job mode.

JobParameterFileVersionKind

The valid type of parameter file version

JobPhaseStatus

Job Phase status.

JobTypes

Job type.

LifecycleStates

Possible lifecycle states.

MetadataRemap.TypeEnum

MigrationDatabaseTargetTypes

Possible Migration Database Target types to specify.

MigrationDatabaseTargetTypesUpdate

Possible Migration Database Target types to specify.

MigrationLifecycleStates

Possible Migration lifecycle states.

MigrationStatus

Possible Migration status.

MigrationTypes

Supported Migration types.

MySqlDataTransferMediumDetails.TypeEnum

MysqlConnection.SecurityProtocolEnum

MysqlConnection.SslModeEnum

MysqlConnection.TechnologyTypeEnum

ObjectStatus

exclude/include status.

OdmsJobPhases

Possible ODMS Job Phases.

OdmsPhaseActions

Possible ODMS Job Phase actions.

OperationStatus

Possible operation status.

OperationTypes

Possible operation types.

OracleConnection.TechnologyTypeEnum

OracleDataTransferMediumDetails.TypeEnum

PhaseExtractTypes

Job Phase extract type.

PrimaryKeyCompatibility

Primary Key Compatibility option. IGNORE_MISSING_PKS - Make the instance, schema, or table dump utility ignore any missing primary keys when the dump is carried out, CREATE_INVISIBLE_PKS - Add a flag in the dump metadata to notify MySQL Shell\u2019s dump loading utility to add primary keys in invisible columns, for each table that does not contain a primary key.

ReasonKeywords

Object exclusion reason category.

ReplicatPerformanceProfile

GoldenGate Replicat performance profile

ResultType

Type of Result.

SortOrders

Sort orders.

TechnologyType

The specific database technology for a type of database connection. Example: OCI_AUTONOMOUS_DATABASE for an ORACLE connection type.

UnsupportedDatabaseObject.TypeEnum

UpdateHostDumpTransferDetails.KindEnum

UpdateMySqlDataTransferMediumDetails.TypeEnum

UpdateOracleDataTransferMediumDetails.TypeEnum

WorkRequestResource.ActionTypeEnum

WorkRequestSummary.StatusEnum

In this article
Back to top