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

Represents a CutoverStep.

Package

@google-cloud/vmmigration

Constructors

(constructor)(properties)

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

Constructs a new CutoverStep.

Parameter
NameDescription
properties ICutoverStep

Properties to set

Properties

endTime

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

CutoverStep endTime.

finalSync

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

CutoverStep finalSync.

instantiatingMigratedVm

public instantiatingMigratedVm?: (google.cloud.vmmigration.v1.IInstantiatingMigratedVMStep|null);

CutoverStep instantiatingMigratedVm.

preparingVmDisks

public preparingVmDisks?: (google.cloud.vmmigration.v1.IPreparingVMDisksStep|null);

CutoverStep preparingVmDisks.

previousReplicationCycle

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

CutoverStep previousReplicationCycle.

shuttingDownSourceVm

public shuttingDownSourceVm?: (google.cloud.vmmigration.v1.IShuttingDownSourceVMStep|null);

CutoverStep shuttingDownSourceVm.

startTime

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

CutoverStep startTime.

step

public step?: ("previousReplicationCycle"|"shuttingDownSourceVm"|"finalSync"|"preparingVmDisks"|"instantiatingMigratedVm");

CutoverStep step.

Methods

create(properties)

public static create(properties?: google.cloud.vmmigration.v1.ICutoverStep): google.cloud.vmmigration.v1.CutoverStep;

Creates a new CutoverStep instance using the specified properties.

Parameter
NameDescription
properties ICutoverStep

Properties to set

Returns
TypeDescription
google.cloud.vmmigration.v1.CutoverStep

CutoverStep instance

decode(reader, length)

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

Decodes a CutoverStep message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.vmmigration.v1.CutoverStep

CutoverStep

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.vmmigration.v1.CutoverStep

CutoverStep

encode(message, writer)

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

Encodes the specified CutoverStep message. Does not implicitly messages.

Parameters
NameDescription
message ICutoverStep

CutoverStep message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message ICutoverStep

CutoverStep message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.vmmigration.v1.CutoverStep

CutoverStep

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CutoverStep

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this CutoverStep to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.vmmigration.v1.CutoverStep

CutoverStep

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a CutoverStep message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not