Class protos.google.cloud.clouddms.v1.MigrationJob (1.0.5)

Represents a MigrationJob.

Package

@google-cloud/dms!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.clouddms.v1.IMigrationJob);

Constructs a new MigrationJob.

Parameter

Name	Description
properties	`IMigrationJob` Properties to set

Properties

connectivity

public connectivity?: ("reverseSshConnectivity"|"vpcPeeringConnectivity"|"staticIpConnectivity");

MigrationJob connectivity.

Property Value

Type	Description
("reverseSshConnectivity"\|"vpcPeeringConnectivity"\|"staticIpConnectivity")

createTime

public createTime?: (google.protobuf.ITimestamp|null);

MigrationJob createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

destination

public destination: string;

MigrationJob destination.

Property Value

Type	Description
string

destinationDatabase

public destinationDatabase?: (google.cloud.clouddms.v1.IDatabaseType|null);

MigrationJob destinationDatabase.

Property Value

Type	Description
(google.cloud.clouddms.v1.IDatabaseType\|null)

displayName

public displayName: string;

MigrationJob displayName.

Property Value

Type	Description
string

dumpPath

public dumpPath: string;

MigrationJob dumpPath.

Property Value

Type	Description
string

duration

public duration?: (google.protobuf.IDuration|null);

MigrationJob duration.

Property Value

Type	Description
(google.protobuf.IDuration\|null)

endTime

public endTime?: (google.protobuf.ITimestamp|null);

MigrationJob endTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

error

public error?: (google.rpc.IStatus|null);

MigrationJob error.

Property Value

Type	Description
(google.rpc.IStatus\|null)

labels

public labels: { [k: string]: string };

MigrationJob labels.

Property Value

Type	Description
{ [k: string]: string }

name

public name: string;

MigrationJob name.

Property Value

Type	Description
string

phase

public phase: (google.cloud.clouddms.v1.MigrationJob.Phase|keyof typeof google.cloud.clouddms.v1.MigrationJob.Phase);

MigrationJob phase.

Property Value

Type	Description
(google.cloud.clouddms.v1.MigrationJob.Phase\|keyof typeof google.cloud.clouddms.v1.MigrationJob.Phase)

reverseSshConnectivity

public reverseSshConnectivity?: (google.cloud.clouddms.v1.IReverseSshConnectivity|null);

MigrationJob reverseSshConnectivity.

Property Value

Type	Description
(google.cloud.clouddms.v1.IReverseSshConnectivity\|null)

source

public source: string;

MigrationJob source.

Property Value

Type	Description
string

sourceDatabase

public sourceDatabase?: (google.cloud.clouddms.v1.IDatabaseType|null);

MigrationJob sourceDatabase.

Property Value

Type	Description
(google.cloud.clouddms.v1.IDatabaseType\|null)

state

public state: (google.cloud.clouddms.v1.MigrationJob.State|keyof typeof google.cloud.clouddms.v1.MigrationJob.State);

MigrationJob state.

Property Value

Type	Description
(google.cloud.clouddms.v1.MigrationJob.State\|keyof typeof google.cloud.clouddms.v1.MigrationJob.State)

staticIpConnectivity

public staticIpConnectivity?: (google.cloud.clouddms.v1.IStaticIpConnectivity|null);

MigrationJob staticIpConnectivity.

Property Value

Type	Description
(google.cloud.clouddms.v1.IStaticIpConnectivity\|null)

type

public type: (google.cloud.clouddms.v1.MigrationJob.Type|keyof typeof google.cloud.clouddms.v1.MigrationJob.Type);

MigrationJob type.

Property Value

Type	Description
(google.cloud.clouddms.v1.MigrationJob.Type\|keyof typeof google.cloud.clouddms.v1.MigrationJob.Type)

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

MigrationJob updateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

vpcPeeringConnectivity

public vpcPeeringConnectivity?: (google.cloud.clouddms.v1.IVpcPeeringConnectivity|null);

MigrationJob vpcPeeringConnectivity.

Property Value

Type	Description
(google.cloud.clouddms.v1.IVpcPeeringConnectivity\|null)

Methods

create(properties)

public static create(properties?: google.cloud.clouddms.v1.IMigrationJob): google.cloud.clouddms.v1.MigrationJob;

Creates a new MigrationJob instance using the specified properties.

Parameter

Name	Description
properties	`IMigrationJob` Properties to set

Returns

Type	Description
google.cloud.clouddms.v1.MigrationJob	MigrationJob instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.clouddms.v1.MigrationJob;

Decodes a MigrationJob message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.clouddms.v1.MigrationJob	MigrationJob

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.clouddms.v1.MigrationJob;

Decodes a MigrationJob message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.clouddms.v1.MigrationJob	MigrationJob

encode(message, writer)

public static encode(message: google.cloud.clouddms.v1.IMigrationJob, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified MigrationJob message. Does not implicitly messages.

Parameters

Name	Description
message	`IMigrationJob` MigrationJob message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.clouddms.v1.IMigrationJob, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified MigrationJob message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	`IMigrationJob` MigrationJob message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.clouddms.v1.MigrationJob;

Creates a MigrationJob message from a plain object. Also converts values to their respective internal types.

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
google.cloud.clouddms.v1.MigrationJob	MigrationJob

toJSON()

public toJSON(): { [k: string]: any };

Converts this MigrationJob to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.clouddms.v1.MigrationJob, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a MigrationJob message. Also converts values to other types if specified.

Parameters

Name	Description
message	`google.cloud.clouddms.v1.MigrationJob` MigrationJob
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a MigrationJob message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not