Represents a Snapshot.
Package
@google-cloud/computeConstructors
(constructor)(properties)
constructor(properties?: google.cloud.compute.v1.ISnapshot);Constructs a new Snapshot.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISnapshot
Properties to set |
Properties
_architecture
public _architecture?: "architecture";Snapshot _architecture.
_autoCreated
public _autoCreated?: "autoCreated";Snapshot _autoCreated.
_chainName
public _chainName?: "chainName";Snapshot _chainName.
_creationSizeBytes
public _creationSizeBytes?: "creationSizeBytes";Snapshot _creationSizeBytes.
_creationTimestamp
public _creationTimestamp?: "creationTimestamp";Snapshot _creationTimestamp.
_description
public _description?: "description";Snapshot _description.
_diskSizeGb
public _diskSizeGb?: "diskSizeGb";Snapshot _diskSizeGb.
_downloadBytes
public _downloadBytes?: "downloadBytes";Snapshot _downloadBytes.
_enableConfidentialCompute
public _enableConfidentialCompute?: "enableConfidentialCompute";Snapshot _enableConfidentialCompute.
_id
public _id?: "id";Snapshot _id.
_kind
public _kind?: "kind";Snapshot _kind.
_labelFingerprint
public _labelFingerprint?: "labelFingerprint";Snapshot _labelFingerprint.
_locationHint
public _locationHint?: "locationHint";Snapshot _locationHint.
_name
public _name?: "name";Snapshot _name.
_satisfiesPzi
public _satisfiesPzi?: "satisfiesPzi";Snapshot _satisfiesPzi.
_satisfiesPzs
public _satisfiesPzs?: "satisfiesPzs";Snapshot _satisfiesPzs.
_selfLink
public _selfLink?: "selfLink";Snapshot _selfLink.
_snapshotEncryptionKey
public _snapshotEncryptionKey?: "snapshotEncryptionKey";Snapshot _snapshotEncryptionKey.
_snapshotType
public _snapshotType?: "snapshotType";Snapshot _snapshotType.
_sourceDisk
public _sourceDisk?: "sourceDisk";Snapshot _sourceDisk.
_sourceDiskEncryptionKey
public _sourceDiskEncryptionKey?: "sourceDiskEncryptionKey";Snapshot _sourceDiskEncryptionKey.
_sourceDiskForRecoveryCheckpoint
public _sourceDiskForRecoveryCheckpoint?: "sourceDiskForRecoveryCheckpoint";Snapshot _sourceDiskForRecoveryCheckpoint.
_sourceDiskId
public _sourceDiskId?: "sourceDiskId";Snapshot _sourceDiskId.
_sourceInstantSnapshot
public _sourceInstantSnapshot?: "sourceInstantSnapshot";Snapshot _sourceInstantSnapshot.
_sourceInstantSnapshotEncryptionKey
public _sourceInstantSnapshotEncryptionKey?: "sourceInstantSnapshotEncryptionKey";Snapshot _sourceInstantSnapshotEncryptionKey.
_sourceInstantSnapshotId
public _sourceInstantSnapshotId?: "sourceInstantSnapshotId";Snapshot _sourceInstantSnapshotId.
_sourceSnapshotSchedulePolicy
public _sourceSnapshotSchedulePolicy?: "sourceSnapshotSchedulePolicy";Snapshot _sourceSnapshotSchedulePolicy.
_sourceSnapshotSchedulePolicyId
public _sourceSnapshotSchedulePolicyId?: "sourceSnapshotSchedulePolicyId";Snapshot _sourceSnapshotSchedulePolicyId.
_status
public _status?: "status";Snapshot _status.
_storageBytes
public _storageBytes?: "storageBytes";Snapshot _storageBytes.
_storageBytesStatus
public _storageBytesStatus?: "storageBytesStatus";Snapshot _storageBytesStatus.
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.
guestOsFeatures
public guestOsFeatures: google.cloud.compute.v1.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.
satisfiesPzi
public satisfiesPzi?: (boolean|null);Snapshot satisfiesPzi.
satisfiesPzs
public satisfiesPzs?: (boolean|null);Snapshot satisfiesPzs.
selfLink
public selfLink?: (string|null);Snapshot selfLink.
snapshotEncryptionKey
public snapshotEncryptionKey?: (google.cloud.compute.v1.ICustomerEncryptionKey|null);Snapshot snapshotEncryptionKey.
snapshotType
public snapshotType?: (string|null);Snapshot snapshotType.
sourceDisk
public sourceDisk?: (string|null);Snapshot sourceDisk.
sourceDiskEncryptionKey
public sourceDiskEncryptionKey?: (google.cloud.compute.v1.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.v1.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.
Methods
create(properties)
public static create(properties?: google.cloud.compute.v1.ISnapshot): google.cloud.compute.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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) |
|