public sealed class MigrationJob : IMessage<MigrationJob>, IEquatable<MigrationJob>, IDeepCloneable<MigrationJob>, IBufferMessage, IMessage
Reference documentation and code samples for the Database Migration v1 API class MigrationJob.
Represents a Database Migration Service migration job object.
Implements
IMessageMigrationJob, IEquatableMigrationJob, IDeepCloneableMigrationJob, IBufferMessage, IMessageNamespace
Google.Cloud.CloudDms.V1Assembly
Google.Cloud.CloudDms.V1.dll
Constructors
MigrationJob()
public MigrationJob()
MigrationJob(MigrationJob)
public MigrationJob(MigrationJob other)
Parameter | |
---|---|
Name | Description |
other | MigrationJob |
Properties
CmekKeyName
public string CmekKeyName { get; set; }
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]
Property Value | |
---|---|
Type | Description |
string |
ConnectivityCase
public MigrationJob.ConnectivityOneofCase ConnectivityCase { get; }
Property Value | |
---|---|
Type | Description |
MigrationJobConnectivityOneofCase |
ConversionWorkspace
public ConversionWorkspaceInfo ConversionWorkspace { get; set; }
The conversion workspace used by the migration.
Property Value | |
---|---|
Type | Description |
ConversionWorkspaceInfo |
CreateTime
public Timestamp CreateTime { get; set; }
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".
Property Value | |
---|---|
Type | Description |
Timestamp |
Destination
public string Destination { get; set; }
Required. The resource name (URI) of the destination connection profile.
Property Value | |
---|---|
Type | Description |
string |
DestinationDatabase
public DatabaseType DestinationDatabase { get; set; }
The database engine type and provider of the destination.
Property Value | |
---|---|
Type | Description |
DatabaseType |
DisplayName
public string DisplayName { get; set; }
The migration job display name.
Property Value | |
---|---|
Type | Description |
string |
DumpFlags
public MigrationJob.Types.DumpFlags DumpFlags { get; set; }
The initial dump flags. This field and the "dump_path" field are mutually exclusive.
Property Value | |
---|---|
Type | Description |
MigrationJobTypesDumpFlags |
DumpPath
public string DumpPath { get; set; }
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.
Property Value | |
---|---|
Type | Description |
string |
Duration
public Duration Duration { get; set; }
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".
Property Value | |
---|---|
Type | Description |
Duration |
EndTime
public Timestamp EndTime { get; set; }
Output only. If the migration job is completed, the time when it was completed.
Property Value | |
---|---|
Type | Description |
Timestamp |
Error
public Status Error { get; set; }
Output only. The error details in case of state FAILED.
Property Value | |
---|---|
Type | Description |
Status |
Filter
public string Filter { get; set; }
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.
Property Value | |
---|---|
Type | Description |
string |
Labels
public MapField<string, string> Labels { get; }
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" }
.
Property Value | |
---|---|
Type | Description |
MapFieldstringstring |
MigrationJobName
public MigrationJobName MigrationJobName { get; set; }
MigrationJobName-typed view over the Name resource name property.
Property Value | |
---|---|
Type | Description |
MigrationJobName |
Name
public string Name { get; set; }
The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
Property Value | |
---|---|
Type | Description |
string |
PerformanceConfig
public MigrationJob.Types.PerformanceConfig PerformanceConfig { get; set; }
Optional. Data dump parallelism settings used by the migration. Currently applicable only for MySQL to Cloud SQL for MySQL migrations only.
Property Value | |
---|---|
Type | Description |
MigrationJobTypesPerformanceConfig |
Phase
public MigrationJob.Types.Phase Phase { get; set; }
Output only. The current migration job phase.
Property Value | |
---|---|
Type | Description |
MigrationJobTypesPhase |
ReverseSshConnectivity
public ReverseSshConnectivity ReverseSshConnectivity { get; set; }
The details needed to communicate to the source over Reverse SSH tunnel connectivity.
Property Value | |
---|---|
Type | Description |
ReverseSshConnectivity |
Source
public string Source { get; set; }
Required. The resource name (URI) of the source connection profile.
Property Value | |
---|---|
Type | Description |
string |
SourceDatabase
public DatabaseType SourceDatabase { get; set; }
The database engine type and provider of the source.
Property Value | |
---|---|
Type | Description |
DatabaseType |
State
public MigrationJob.Types.State State { get; set; }
The current migration job state.
Property Value | |
---|---|
Type | Description |
MigrationJobTypesState |
StaticIpConnectivity
public StaticIpConnectivity StaticIpConnectivity { get; set; }
static ip connectivity data (default, no additional details needed).
Property Value | |
---|---|
Type | Description |
StaticIpConnectivity |
Type
public MigrationJob.Types.Type Type { get; set; }
Required. The migration job type.
Property Value | |
---|---|
Type | Description |
MigrationJobTypesType |
UpdateTime
public Timestamp UpdateTime { get; set; }
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".
Property Value | |
---|---|
Type | Description |
Timestamp |
VpcPeeringConnectivity
public VpcPeeringConnectivity VpcPeeringConnectivity { get; set; }
The details of the VPC network that the source database is located in.
Property Value | |
---|---|
Type | Description |
VpcPeeringConnectivity |