Class protos.google.cloud.vmmigration.v1.MigratingVm (2.3.1)

Represents a MigratingVm.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.vmmigration.v1.IMigratingVm);

Constructs a new MigratingVm.

Parameter
Name	Description
`properties`	`IMigratingVm` Properties to set

Properties

awsSourceVmDetails

public awsSourceVmDetails?: (google.cloud.vmmigration.v1.IAwsSourceVmDetails|null);

MigratingVm awsSourceVmDetails.

computeEngineTargetDefaults

public computeEngineTargetDefaults?: (google.cloud.vmmigration.v1.IComputeEngineTargetDefaults|null);

MigratingVm computeEngineTargetDefaults.

createTime

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

MigratingVm createTime.

currentSyncInfo

public currentSyncInfo?: (google.cloud.vmmigration.v1.IReplicationCycle|null);

MigratingVm currentSyncInfo.

description

public description: string;

MigratingVm description.

displayName

public displayName: string;

MigratingVm displayName.

error

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

MigratingVm error.

group

public group: string;

MigratingVm group.

labels

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

MigratingVm labels.

lastSync

public lastSync?: (google.cloud.vmmigration.v1.IReplicationSync|null);

MigratingVm lastSync.

name

public name: string;

MigratingVm name.

policy

public policy?: (google.cloud.vmmigration.v1.ISchedulePolicy|null);

MigratingVm policy.

recentCloneJobs

public recentCloneJobs: google.cloud.vmmigration.v1.ICloneJob[];

MigratingVm recentCloneJobs.

recentCutoverJobs

public recentCutoverJobs: google.cloud.vmmigration.v1.ICutoverJob[];

MigratingVm recentCutoverJobs.

sourceVmDetails

public sourceVmDetails?: "awsSourceVmDetails";

MigratingVm sourceVmDetails.

sourceVmId

public sourceVmId: string;

MigratingVm sourceVmId.

state

public state: (google.cloud.vmmigration.v1.MigratingVm.State|keyof typeof google.cloud.vmmigration.v1.MigratingVm.State);

MigratingVm state.

stateTime

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

MigratingVm stateTime.

targetVmDefaults

public targetVmDefaults?: "computeEngineTargetDefaults";

MigratingVm targetVmDefaults.

updateTime

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

MigratingVm updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.vmmigration.v1.IMigratingVm): google.cloud.vmmigration.v1.MigratingVm;

Creates a new MigratingVm instance using the specified properties.

Parameter
Name	Description
`properties`	`IMigratingVm` Properties to set

Returns
Type	Description
`google.cloud.vmmigration.v1.MigratingVm`	MigratingVm instance

decode(reader, length)

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

Decodes a MigratingVm 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.vmmigration.v1.MigratingVm`	MigratingVm

decodeDelimited(reader)

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

Decodes a MigratingVm 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.vmmigration.v1.MigratingVm`	MigratingVm

encode(message, writer)

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

Encodes the specified MigratingVm message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IMigratingVm` MigratingVm 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.vmmigration.v1.IMigratingVm, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IMigratingVm` MigratingVm 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.vmmigration.v1.MigratingVm;

Creates a MigratingVm 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.vmmigration.v1.MigratingVm`	MigratingVm

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for MigratingVm

Parameter
Name	Description
`typeUrlPrefix`	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type	Description
`string`	The default type url

toJSON()

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

Converts this MigratingVm to JSON.

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

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`google.cloud.vmmigration.v1.MigratingVm` MigratingVm
`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 MigratingVm 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