Class MigrationJob (1.8.0)

MigrationJob(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a Database Migration Service migration job object.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
`name`	`str` The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
`create_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
`update_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
`labels`	`MutableMapping[str, str]` The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`display_name`	`str` The migration job display name.
`state`	`google.cloud.clouddms_v1.types.MigrationJob.State` The current migration job state.
`phase`	`google.cloud.clouddms_v1.types.MigrationJob.Phase` Output only. The current migration job phase.
`type_`	`google.cloud.clouddms_v1.types.MigrationJob.Type` Required. The migration job type.
`dump_path`	`str` The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive.
`dump_flags`	`google.cloud.clouddms_v1.types.MigrationJob.DumpFlags` The initial dump flags. This field and the "dump_path" field are mutually exclusive.
`source`	`str` Required. The resource name (URI) of the source connection profile.
`destination`	`str` Required. The resource name (URI) of the destination connection profile.
`reverse_ssh_connectivity`	`google.cloud.clouddms_v1.types.ReverseSshConnectivity` The details needed to communicate to the source over Reverse SSH tunnel connectivity. This field is a member of `oneof`_ `connectivity`.
`vpc_peering_connectivity`	`google.cloud.clouddms_v1.types.VpcPeeringConnectivity` The details of the VPC network that the source database is located in. This field is a member of `oneof`_ `connectivity`.
`static_ip_connectivity`	`google.cloud.clouddms_v1.types.StaticIpConnectivity` static ip connectivity data (default, no additional details needed). This field is a member of `oneof`_ `connectivity`.
`duration`	`google.protobuf.duration_pb2.Duration` Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
`error`	`google.rpc.status_pb2.Status` Output only. The error details in case of state FAILED.
`source_database`	`google.cloud.clouddms_v1.types.DatabaseType` The database engine type and provider of the source.
`destination_database`	`google.cloud.clouddms_v1.types.DatabaseType` The database engine type and provider of the destination.
`end_time`	`google.protobuf.timestamp_pb2.Timestamp` Output only. If the migration job is completed, the time when it was completed.
`conversion_workspace`	`google.cloud.clouddms_v1.types.ConversionWorkspaceInfo` The conversion workspace used by the migration.
`filter`	`str` This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace.
`cmek_key_name`	`str` The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: - Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). - PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). - PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
`performance_config`	`google.cloud.clouddms_v1.types.MigrationJob.PerformanceConfig` Optional. Data dump parallelism settings used by the migration. Currently applicable only for MySQL to Cloud SQL for MySQL migrations only.

Classes

DumpFlag

DumpFlag(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Dump flag definition.

DumpFlags

DumpFlags(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Dump flags definition.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.

PerformanceConfig

PerformanceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Performance configuration definition.

Phase

Phase(value)

The current migration job phase.

Values: PHASE_UNSPECIFIED (0): The phase of the migration job is unknown. FULL_DUMP (1): The migration job is in the full dump phase. CDC (2): The migration job is CDC phase. PROMOTE_IN_PROGRESS (3): The migration job is running the promote phase. WAITING_FOR_SOURCE_WRITES_TO_STOP (4): Only RDS flow - waiting for source writes to stop PREPARING_THE_DUMP (5): Only RDS flow - the sources writes stopped, waiting for dump to begin

State

State(value)

The current migration job states.

Values: STATE_UNSPECIFIED (0): The state of the migration job is unknown. MAINTENANCE (1): The migration job is down for maintenance. DRAFT (2): The migration job is in draft mode and no resources are created. CREATING (3): The migration job is being created. NOT_STARTED (4): The migration job is created and not started. RUNNING (5): The migration job is running. FAILED (6): The migration job failed. COMPLETED (7): The migration job has been completed. DELETING (8): The migration job is being deleted. STOPPING (9): The migration job is being stopped. STOPPED (10): The migration job is currently stopped. DELETED (11): The migration job has been deleted. UPDATING (12): The migration job is being updated. STARTING (13): The migration job is starting. RESTARTING (14): The migration job is restarting. RESUMING (15): The migration job is resuming.

Type

Type(value)

The type of migration job (one-time or continuous).

Values: TYPE_UNSPECIFIED (0): The type of the migration job is unknown. ONE_TIME (1): The migration job is a one time migration. CONTINUOUS (2): The migration job is a continuous migration.