Class protos.google.cloud.vmmigration.v1.CloneJob (3.0.2)

Represents a CloneJob.

Package

@google-cloud/vmmigration

Constructors

(constructor)(properties)

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

Constructs a new CloneJob.

Parameter
NameDescription
properties ICloneJob

Properties to set

Properties

computeEngineTargetDetails

public computeEngineTargetDetails?: (google.cloud.vmmigration.v1.IComputeEngineTargetDetails|null);

CloneJob computeEngineTargetDetails.

createTime

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

CloneJob createTime.

endTime

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

CloneJob endTime.

error

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

CloneJob error.

name

public name: string;

CloneJob name.

state

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

CloneJob state.

stateTime

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

CloneJob stateTime.

steps

public steps: google.cloud.vmmigration.v1.ICloneStep[];

CloneJob steps.

targetVmDetails

public targetVmDetails?: "computeEngineTargetDetails";

CloneJob targetVmDetails.

Methods

create(properties)

public static create(properties?: google.cloud.vmmigration.v1.ICloneJob): google.cloud.vmmigration.v1.CloneJob;

Creates a new CloneJob instance using the specified properties.

Parameter
NameDescription
properties ICloneJob

Properties to set

Returns
TypeDescription
CloneJob

CloneJob instance

decode(reader, length)

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

Decodes a CloneJob message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
CloneJob

CloneJob

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
CloneJob

CloneJob

encode(message, writer)

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

Encodes the specified CloneJob message. Does not implicitly messages.

Parameters
NameDescription
message ICloneJob

CloneJob 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.ICloneJob, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ICloneJob

CloneJob 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.CloneJob;

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

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

Plain object

Returns
TypeDescription
CloneJob

CloneJob

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CloneJob

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 CloneJob to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message CloneJob

CloneJob

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 CloneJob 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