Disk

google.cloud.compute.v1. Disk

Represents a Disk.

Constructor

new Disk(propertiesopt)

Constructs a new Disk.

Parameters:
Name Type Attributes Description
properties google.cloud.compute.v1.IDisk <optional>

Properties to set

Implements:
  • IDisk

Members

_architecture

Disk _architecture.

_creationTimestamp

Disk _creationTimestamp.

_description

Disk _description.

_diskEncryptionKey

Disk _diskEncryptionKey.

_id

Disk _id.

_kind

Disk _kind.

_labelFingerprint

Disk _labelFingerprint.

_lastAttachTimestamp

Disk _lastAttachTimestamp.

_lastDetachTimestamp

Disk _lastDetachTimestamp.

_locationHint

Disk _locationHint.

_name

Disk _name.

_options

Disk _options.

_params

Disk _params.

_physicalBlockSizeBytes

Disk _physicalBlockSizeBytes.

_provisionedIops

Disk _provisionedIops.

_region

Disk _region.

_satisfiesPzs

Disk _satisfiesPzs.

Disk _selfLink.

_sizeGb

Disk _sizeGb.

_sourceDisk

Disk _sourceDisk.

_sourceDiskId

Disk _sourceDiskId.

_sourceImage

Disk _sourceImage.

_sourceImageEncryptionKey

Disk _sourceImageEncryptionKey.

_sourceImageId

Disk _sourceImageId.

_sourceSnapshot

Disk _sourceSnapshot.

_sourceSnapshotEncryptionKey

Disk _sourceSnapshotEncryptionKey.

_sourceSnapshotId

Disk _sourceSnapshotId.

_sourceStorageObject

Disk _sourceStorageObject.

_status

Disk _status.

_type

Disk _type.

_zone

Disk _zone.

architecture

Disk architecture.

creationTimestamp

Disk creationTimestamp.

description

Disk description.

diskEncryptionKey

Disk diskEncryptionKey.

guestOsFeatures

Disk guestOsFeatures.

id

Disk id.

kind

Disk kind.

labelFingerprint

Disk labelFingerprint.

labels

Disk labels.

lastAttachTimestamp

Disk lastAttachTimestamp.

lastDetachTimestamp

Disk lastDetachTimestamp.

licenseCodes

Disk licenseCodes.

licenses

Disk licenses.

locationHint

Disk locationHint.

name

Disk name.

options

Disk options.

params

Disk params.

physicalBlockSizeBytes

Disk physicalBlockSizeBytes.

provisionedIops

Disk provisionedIops.

region

Disk region.

replicaZones

Disk replicaZones.

resourcePolicies

Disk resourcePolicies.

satisfiesPzs

Disk satisfiesPzs.

Disk selfLink.

sizeGb

Disk sizeGb.

sourceDisk

Disk sourceDisk.

sourceDiskId

Disk sourceDiskId.

sourceImage

Disk sourceImage.

sourceImageEncryptionKey

Disk sourceImageEncryptionKey.

sourceImageId

Disk sourceImageId.

sourceSnapshot

Disk sourceSnapshot.

sourceSnapshotEncryptionKey

Disk sourceSnapshotEncryptionKey.

sourceSnapshotId

Disk sourceSnapshotId.

sourceStorageObject

Disk sourceStorageObject.

status

Disk status.

type

Disk type.

users

Disk users.

zone

Disk zone.

Architecture

Architecture enum.

Properties:
Name Type Description
UNDEFINED_ARCHITECTURE number

UNDEFINED_ARCHITECTURE value

ARCHITECTURE_UNSPECIFIED number

ARCHITECTURE_UNSPECIFIED value

ARM64 number

ARM64 value

X86_64 number

X86_64 value

Status

Status enum.

Properties:
Name Type Description
UNDEFINED_STATUS number

UNDEFINED_STATUS value

CREATING number

CREATING value

DELETING number

DELETING value

FAILED number

FAILED value

READY number

READY value

RESTORING number

RESTORING value

Methods

toJSON() → {Object.<string, *>}

Converts this Disk to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.compute.v1.Disk}

Creates a new Disk instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.compute.v1.IDisk <optional>

Properties to set

Returns:
Type Description
google.cloud.compute.v1.Disk

Disk instance

(static) decode(reader, lengthopt) → {google.cloud.compute.v1.Disk}

Decodes a Disk message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.compute.v1.Disk

Disk

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.compute.v1.Disk}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.compute.v1.Disk

Disk

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Disk message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.IDisk

Disk message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.IDisk

Disk message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.compute.v1.Disk}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.compute.v1.Disk

Disk

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Disk

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

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

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.Disk

Disk

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Disk message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not