Class protos.google.cloud.compute.v1beta.Snapshot (6.13.0)

Represents a Snapshot.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1beta.ISnapshot);

Constructs a new Snapshot.

Parameter
Name Description
properties ISnapshot

Properties to set

Properties

architecture

public architecture?: (string|null);

Snapshot architecture.

autoCreated

public autoCreated?: (boolean|null);

Snapshot autoCreated.

chainName

public chainName?: (string|null);

Snapshot chainName.

creationSizeBytes

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

Snapshot creationSizeBytes.

creationTimestamp

public creationTimestamp?: (string|null);

Snapshot creationTimestamp.

description

public description?: (string|null);

Snapshot description.

diskSizeGb

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

Snapshot diskSizeGb.

downloadBytes

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

Snapshot downloadBytes.

enableConfidentialCompute

public enableConfidentialCompute?: (boolean|null);

Snapshot enableConfidentialCompute.

guestFlush

public guestFlush?: (boolean|null);

Snapshot guestFlush.

guestOsFeatures

public guestOsFeatures: google.cloud.compute.v1beta.IGuestOsFeature[];

Snapshot guestOsFeatures.

id

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

Snapshot id.

kind

public kind?: (string|null);

Snapshot kind.

labelFingerprint

public labelFingerprint?: (string|null);

Snapshot labelFingerprint.

labels

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

Snapshot labels.

licenseCodes

public licenseCodes: (number|Long|string)[];

Snapshot licenseCodes.

licenses

public licenses: string[];

Snapshot licenses.

locationHint

public locationHint?: (string|null);

Snapshot locationHint.

name

public name?: (string|null);

Snapshot name.

params

public params?: (google.cloud.compute.v1beta.ISnapshotParams|null);

Snapshot params.

region

public region?: (string|null);

Snapshot region.

satisfiesPzi

public satisfiesPzi?: (boolean|null);

Snapshot satisfiesPzi.

satisfiesPzs

public satisfiesPzs?: (boolean|null);

Snapshot satisfiesPzs.

public selfLink?: (string|null);

Snapshot selfLink.

snapshotEncryptionKey

public snapshotEncryptionKey?: (google.cloud.compute.v1beta.ICustomerEncryptionKey|null);

Snapshot snapshotEncryptionKey.

snapshotGroupId

public snapshotGroupId?: (string|null);

Snapshot snapshotGroupId.

snapshotGroupName

public snapshotGroupName?: (string|null);

Snapshot snapshotGroupName.

snapshotType

public snapshotType?: (string|null);

Snapshot snapshotType.

sourceDisk

public sourceDisk?: (string|null);

Snapshot sourceDisk.

sourceDiskEncryptionKey

public sourceDiskEncryptionKey?: (google.cloud.compute.v1beta.ICustomerEncryptionKey|null);

Snapshot sourceDiskEncryptionKey.

sourceDiskForRecoveryCheckpoint

public sourceDiskForRecoveryCheckpoint?: (string|null);

Snapshot sourceDiskForRecoveryCheckpoint.

sourceDiskId

public sourceDiskId?: (string|null);

Snapshot sourceDiskId.

sourceInstantSnapshot

public sourceInstantSnapshot?: (string|null);

Snapshot sourceInstantSnapshot.

sourceInstantSnapshotEncryptionKey

public sourceInstantSnapshotEncryptionKey?: (google.cloud.compute.v1beta.ICustomerEncryptionKey|null);

Snapshot sourceInstantSnapshotEncryptionKey.

sourceInstantSnapshotId

public sourceInstantSnapshotId?: (string|null);

Snapshot sourceInstantSnapshotId.

sourceSnapshotSchedulePolicy

public sourceSnapshotSchedulePolicy?: (string|null);

Snapshot sourceSnapshotSchedulePolicy.

sourceSnapshotSchedulePolicyId

public sourceSnapshotSchedulePolicyId?: (string|null);

Snapshot sourceSnapshotSchedulePolicyId.

status

public status?: (string|null);

Snapshot status.

storageBytes

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

Snapshot storageBytes.

storageBytesStatus

public storageBytesStatus?: (string|null);

Snapshot storageBytesStatus.

storageLocations

public storageLocations: string[];

Snapshot storageLocations.

userLicenses

public userLicenses: string[];

Snapshot userLicenses.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1beta.ISnapshot): google.cloud.compute.v1beta.Snapshot;

Creates a new Snapshot instance using the specified properties.

Parameter
Name Description
properties ISnapshot

Properties to set

Returns
Type Description
Snapshot

Snapshot instance

decode(reader, length)

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

Decodes a Snapshot 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
Snapshot

Snapshot

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Snapshot

Snapshot

encode(message, writer)

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

Encodes the specified Snapshot message. Does not implicitly messages.

Parameters
Name Description
message ISnapshot

Snapshot 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.v1beta.ISnapshot, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISnapshot

Snapshot 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.v1beta.Snapshot;

Creates a Snapshot 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
Snapshot

Snapshot

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Snapshot

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Snapshot

Snapshot

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