Show / Hide Table of Contents

Class MigrationJob

Represents a Database Migration Service migration job object.

Inheritance
object
MigrationJob
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.DatabaseMigrationService.v1.Data
Assembly: Google.Apis.DatabaseMigrationService.v1.dll
Syntax
public class MigrationJob : IDirectResponseSchema

Properties

CmekKeyName

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]

Declaration
[JsonProperty("cmekKeyName")]
public virtual string CmekKeyName { get; set; }
Property Value
Type Description
string

ConversionWorkspace

The conversion workspace used by the migration.

Declaration
[JsonProperty("conversionWorkspace")]
public virtual ConversionWorkspaceInfo ConversionWorkspace { get; set; }
Property Value
Type Description
ConversionWorkspaceInfo

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

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".

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

Destination

Required. The resource name (URI) of the destination connection profile.

Declaration
[JsonProperty("destination")]
public virtual string Destination { get; set; }
Property Value
Type Description
string

DestinationDatabase

The database engine type and provider of the destination.

Declaration
[JsonProperty("destinationDatabase")]
public virtual DatabaseType DestinationDatabase { get; set; }
Property Value
Type Description
DatabaseType

DisplayName

The migration job display name.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

DumpFlags

The initial dump flags. This field and the "dump_path" field are mutually exclusive.

Declaration
[JsonProperty("dumpFlags")]
public virtual DumpFlags DumpFlags { get; set; }
Property Value
Type Description
DumpFlags

DumpPath

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.

Declaration
[JsonProperty("dumpPath")]
public virtual string DumpPath { get; set; }
Property Value
Type Description
string

DumpType

Optional. The type of the data dump. Supported for MySQL to CloudSQL for MySQL migrations only.

Declaration
[JsonProperty("dumpType")]
public virtual string DumpType { get; set; }
Property Value
Type Description
string

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".

Declaration
[JsonProperty("duration")]
public virtual object Duration { get; set; }
Property Value
Type Description
object

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EndTime

object representation of EndTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")]
public virtual object EndTime { get; set; }
Property Value
Type Description
object

EndTimeDateTimeOffset

DateTimeOffset representation of EndTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? EndTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

EndTimeRaw

Output only. If the migration job is completed, the time when it was completed.

Declaration
[JsonProperty("endTime")]
public virtual string EndTimeRaw { get; set; }
Property Value
Type Description
string

Error

Output only. The error details in case of state FAILED.

Declaration
[JsonProperty("error")]
public virtual Status Error { get; set; }
Property Value
Type Description
Status

Filter

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.

Declaration
[JsonProperty("filter")]
public virtual string Filter { get; set; }
Property Value
Type Description
string

Labels

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" }.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Name

The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

ObjectsConfig

Optional. The objects that need to be migrated.

Declaration
[JsonProperty("objectsConfig")]
public virtual MigrationJobObjectsConfig ObjectsConfig { get; set; }
Property Value
Type Description
MigrationJobObjectsConfig

OracleToPostgresConfig

Configuration for heterogeneous Oracle to Cloud SQL for PostgreSQL and Oracle to AlloyDB for PostgreSQL migrations.

Declaration
[JsonProperty("oracleToPostgresConfig")]
public virtual OracleToPostgresConfig OracleToPostgresConfig { get; set; }
Property Value
Type Description
OracleToPostgresConfig

PerformanceConfig

Optional. Data dump parallelism settings used by the migration.

Declaration
[JsonProperty("performanceConfig")]
public virtual PerformanceConfig PerformanceConfig { get; set; }
Property Value
Type Description
PerformanceConfig

Phase

Output only. The current migration job phase.

Declaration
[JsonProperty("phase")]
public virtual string Phase { get; set; }
Property Value
Type Description
string

ReverseSshConnectivity

The details needed to communicate to the source over Reverse SSH tunnel connectivity.

Declaration
[JsonProperty("reverseSshConnectivity")]
public virtual ReverseSshConnectivity ReverseSshConnectivity { get; set; }
Property Value
Type Description
ReverseSshConnectivity

SatisfiesPzi

Output only. Reserved for future use.

Declaration
[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }
Property Value
Type Description
bool?

SatisfiesPzs

Output only. Reserved for future use.

Declaration
[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }
Property Value
Type Description
bool?

Source

Required. The resource name (URI) of the source connection profile.

Declaration
[JsonProperty("source")]
public virtual string Source { get; set; }
Property Value
Type Description
string

SourceDatabase

The database engine type and provider of the source.

Declaration
[JsonProperty("sourceDatabase")]
public virtual DatabaseType SourceDatabase { get; set; }
Property Value
Type Description
DatabaseType

SqlserverHomogeneousMigrationJobConfig

Optional. Configuration for SQL Server homogeneous migration.

Declaration
[JsonProperty("sqlserverHomogeneousMigrationJobConfig")]
public virtual SqlServerHomogeneousMigrationJobConfig SqlserverHomogeneousMigrationJobConfig { get; set; }
Property Value
Type Description
SqlServerHomogeneousMigrationJobConfig

SqlserverToPostgresConfig

Configuration for heterogeneous SQL Server to Cloud SQL for PostgreSQL migrations.

Declaration
[JsonProperty("sqlserverToPostgresConfig")]
public virtual SqlServerToPostgresConfig SqlserverToPostgresConfig { get; set; }
Property Value
Type Description
SqlServerToPostgresConfig

State

The current migration job state.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

StaticIpConnectivity

static ip connectivity data (default, no additional details needed).

Declaration
[JsonProperty("staticIpConnectivity")]
public virtual StaticIpConnectivity StaticIpConnectivity { get; set; }
Property Value
Type Description
StaticIpConnectivity

Type

Required. The migration job type.

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

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".

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

VpcPeeringConnectivity

The details of the VPC network that the source database is located in.

Declaration
[JsonProperty("vpcPeeringConnectivity")]
public virtual VpcPeeringConnectivity VpcPeeringConnectivity { get; set; }
Property Value
Type Description
VpcPeeringConnectivity

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX