Class protos.google.cloud.compute.v1.InstantSnapshot (6.5.0)

Represents an InstantSnapshot.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.IInstantSnapshot);

Constructs a new InstantSnapshot.

Parameter
Name Description
properties IInstantSnapshot

Properties to set

Properties

architecture

public architecture?: (string|null);

InstantSnapshot architecture.

creationTimestamp

public creationTimestamp?: (string|null);

InstantSnapshot creationTimestamp.

description

public description?: (string|null);

InstantSnapshot description.

diskSizeGb

public diskSizeGb?: (number|Long|string|null);

InstantSnapshot diskSizeGb.

id

public id?: (number|Long|string|null);

InstantSnapshot id.

kind

public kind?: (string|null);

InstantSnapshot kind.

labelFingerprint

public labelFingerprint?: (string|null);

InstantSnapshot labelFingerprint.

labels

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

InstantSnapshot labels.

name

public name?: (string|null);

InstantSnapshot name.

region

public region?: (string|null);

InstantSnapshot region.

resourceStatus

public resourceStatus?: (google.cloud.compute.v1.IInstantSnapshotResourceStatus|null);

InstantSnapshot resourceStatus.

satisfiesPzi

public satisfiesPzi?: (boolean|null);

InstantSnapshot satisfiesPzi.

satisfiesPzs

public satisfiesPzs?: (boolean|null);

InstantSnapshot satisfiesPzs.

public selfLink?: (string|null);

InstantSnapshot selfLink.

selfLinkWithId

public selfLinkWithId?: (string|null);

InstantSnapshot selfLinkWithId.

sourceDisk

public sourceDisk?: (string|null);

InstantSnapshot sourceDisk.

sourceDiskId

public sourceDiskId?: (string|null);

InstantSnapshot sourceDiskId.

status

public status?: (string|null);

InstantSnapshot status.

zone

public zone?: (string|null);

InstantSnapshot zone.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IInstantSnapshot): google.cloud.compute.v1.InstantSnapshot;

Creates a new InstantSnapshot instance using the specified properties.

Parameter
Name Description
properties IInstantSnapshot

Properties to set

Returns
Type Description
InstantSnapshot

InstantSnapshot instance

decode(reader, length)

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

Decodes an InstantSnapshot message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
InstantSnapshot

InstantSnapshot

decodeDelimited(reader)

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

Decodes an InstantSnapshot message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
InstantSnapshot

InstantSnapshot

encode(message, writer)

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

Encodes the specified InstantSnapshot message. Does not implicitly messages.

Parameters
Name Description
message IInstantSnapshot

InstantSnapshot 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.compute.v1.IInstantSnapshot, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IInstantSnapshot

InstantSnapshot 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.compute.v1.InstantSnapshot;

Creates an InstantSnapshot 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
InstantSnapshot

InstantSnapshot

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for InstantSnapshot

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message InstantSnapshot

InstantSnapshot

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 an InstantSnapshot 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