Class protos.google.cloud.compute.v1.Disk (4.3.0)

Version latest

• 4.3.0 (latest)
• 4.1.0
• 3.9.1
• 3.8.1
• 3.6.0
• 3.5.1
• 3.1.2
• 3.0.0

Represents a Disk.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new Disk.

Parameter
Name	Description
properties	IDisk Properties to set

Properties

_architecture

public _architecture?: "architecture";

Disk _architecture.

_asyncPrimaryDisk

public _asyncPrimaryDisk?: "asyncPrimaryDisk";

Disk _asyncPrimaryDisk.

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

Disk _creationTimestamp.

_description

public _description?: "description";

Disk _description.

_diskEncryptionKey

public _diskEncryptionKey?: "diskEncryptionKey";

Disk _diskEncryptionKey.

_enableConfidentialCompute

public _enableConfidentialCompute?: "enableConfidentialCompute";

Disk _enableConfidentialCompute.

_id

public _id?: "id";

Disk _id.

_kind

public _kind?: "kind";

Disk _kind.

_labelFingerprint

public _labelFingerprint?: "labelFingerprint";

Disk _labelFingerprint.

_lastAttachTimestamp

public _lastAttachTimestamp?: "lastAttachTimestamp";

Disk _lastAttachTimestamp.

_lastDetachTimestamp

public _lastDetachTimestamp?: "lastDetachTimestamp";

Disk _lastDetachTimestamp.

_locationHint

public _locationHint?: "locationHint";

Disk _locationHint.

_name

public _name?: "name";

Disk _name.

_options

public _options?: "options";

Disk _options.

_params

public _params?: "params";

Disk _params.

_physicalBlockSizeBytes

public _physicalBlockSizeBytes?: "physicalBlockSizeBytes";

Disk _physicalBlockSizeBytes.

_provisionedIops

public _provisionedIops?: "provisionedIops";

Disk _provisionedIops.

_provisionedThroughput

public _provisionedThroughput?: "provisionedThroughput";

Disk _provisionedThroughput.

_region

public _region?: "region";

Disk _region.

_resourceStatus

public _resourceStatus?: "resourceStatus";

Disk _resourceStatus.

_satisfiesPzi

public _satisfiesPzi?: "satisfiesPzi";

Disk _satisfiesPzi.

_satisfiesPzs

public _satisfiesPzs?: "satisfiesPzs";

Disk _satisfiesPzs.

_selfLink

public _selfLink?: "selfLink";

Disk _selfLink.

_sizeGb

public _sizeGb?: "sizeGb";

Disk _sizeGb.

_sourceConsistencyGroupPolicy

public _sourceConsistencyGroupPolicy?: "sourceConsistencyGroupPolicy";

Disk _sourceConsistencyGroupPolicy.

_sourceConsistencyGroupPolicyId

public _sourceConsistencyGroupPolicyId?: "sourceConsistencyGroupPolicyId";

Disk _sourceConsistencyGroupPolicyId.

_sourceDisk

public _sourceDisk?: "sourceDisk";

Disk _sourceDisk.

_sourceDiskId

public _sourceDiskId?: "sourceDiskId";

Disk _sourceDiskId.

_sourceImage

public _sourceImage?: "sourceImage";

Disk _sourceImage.

_sourceImageEncryptionKey

public _sourceImageEncryptionKey?: "sourceImageEncryptionKey";

Disk _sourceImageEncryptionKey.

_sourceImageId

public _sourceImageId?: "sourceImageId";

Disk _sourceImageId.

_sourceInstantSnapshot

public _sourceInstantSnapshot?: "sourceInstantSnapshot";

Disk _sourceInstantSnapshot.

_sourceInstantSnapshotId

public _sourceInstantSnapshotId?: "sourceInstantSnapshotId";

Disk _sourceInstantSnapshotId.

_sourceSnapshot

public _sourceSnapshot?: "sourceSnapshot";

Disk _sourceSnapshot.

_sourceSnapshotEncryptionKey

public _sourceSnapshotEncryptionKey?: "sourceSnapshotEncryptionKey";

Disk _sourceSnapshotEncryptionKey.

_sourceSnapshotId

public _sourceSnapshotId?: "sourceSnapshotId";

Disk _sourceSnapshotId.

_sourceStorageObject

public _sourceStorageObject?: "sourceStorageObject";

Disk _sourceStorageObject.

_status

public _status?: "status";

Disk _status.

_type

public _type?: "type";

Disk _type.

_zone

public _zone?: "zone";

Disk _zone.

architecture

public architecture?: (string|null);

Disk architecture.

asyncPrimaryDisk

public asyncPrimaryDisk?: (google.cloud.compute.v1.IDiskAsyncReplication|null);

Disk asyncPrimaryDisk.

asyncSecondaryDisks

public asyncSecondaryDisks: { [k: string]: google.cloud.compute.v1.IDiskAsyncReplicationList };

Disk asyncSecondaryDisks.

creationTimestamp

public creationTimestamp?: (string|null);

Disk creationTimestamp.

description

public description?: (string|null);

Disk description.

diskEncryptionKey

public diskEncryptionKey?: (google.cloud.compute.v1.ICustomerEncryptionKey|null);

Disk diskEncryptionKey.

enableConfidentialCompute

public enableConfidentialCompute?: (boolean|null);

Disk enableConfidentialCompute.

guestOsFeatures

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

Disk guestOsFeatures.

id

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

Disk id.

kind

public kind?: (string|null);

Disk kind.

labelFingerprint

public labelFingerprint?: (string|null);

Disk labelFingerprint.

labels

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

Disk labels.

lastAttachTimestamp

public lastAttachTimestamp?: (string|null);

Disk lastAttachTimestamp.

lastDetachTimestamp

public lastDetachTimestamp?: (string|null);

Disk lastDetachTimestamp.

licenseCodes

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

Disk licenseCodes.

licenses

public licenses: string[];

Disk licenses.

locationHint

public locationHint?: (string|null);

Disk locationHint.

name

public name?: (string|null);

Disk name.

options

public options?: (string|null);

Disk options.

params

public params?: (google.cloud.compute.v1.IDiskParams|null);

Disk params.

physicalBlockSizeBytes

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

Disk physicalBlockSizeBytes.

provisionedIops

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

Disk provisionedIops.

provisionedThroughput

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

Disk provisionedThroughput.

region

public region?: (string|null);

Disk region.

replicaZones

public replicaZones: string[];

Disk replicaZones.

resourcePolicies

public resourcePolicies: string[];

Disk resourcePolicies.

resourceStatus

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

Disk resourceStatus.

satisfiesPzi

public satisfiesPzi?: (boolean|null);

Disk satisfiesPzi.

satisfiesPzs

public satisfiesPzs?: (boolean|null);

Disk satisfiesPzs.

selfLink

public selfLink?: (string|null);

Disk selfLink.

sizeGb

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

Disk sizeGb.

sourceConsistencyGroupPolicy

public sourceConsistencyGroupPolicy?: (string|null);

Disk sourceConsistencyGroupPolicy.

sourceConsistencyGroupPolicyId

public sourceConsistencyGroupPolicyId?: (string|null);

Disk sourceConsistencyGroupPolicyId.

sourceDisk

public sourceDisk?: (string|null);

Disk sourceDisk.

sourceDiskId

public sourceDiskId?: (string|null);

Disk sourceDiskId.

sourceImage

public sourceImage?: (string|null);

Disk sourceImage.

sourceImageEncryptionKey

public sourceImageEncryptionKey?: (google.cloud.compute.v1.ICustomerEncryptionKey|null);

Disk sourceImageEncryptionKey.

sourceImageId

public sourceImageId?: (string|null);

Disk sourceImageId.

sourceInstantSnapshot

public sourceInstantSnapshot?: (string|null);

Disk sourceInstantSnapshot.

sourceInstantSnapshotId

public sourceInstantSnapshotId?: (string|null);

Disk sourceInstantSnapshotId.

sourceSnapshot

public sourceSnapshot?: (string|null);

Disk sourceSnapshot.

sourceSnapshotEncryptionKey

public sourceSnapshotEncryptionKey?: (google.cloud.compute.v1.ICustomerEncryptionKey|null);

Disk sourceSnapshotEncryptionKey.

sourceSnapshotId

public sourceSnapshotId?: (string|null);

Disk sourceSnapshotId.

sourceStorageObject

public sourceStorageObject?: (string|null);

Disk sourceStorageObject.

status

public status?: (string|null);

Disk status.

type

public type?: (string|null);

Disk type.

users

public users: string[];

Disk users.

zone

public zone?: (string|null);

Disk zone.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IDisk): google.cloud.compute.v1.Disk;

Creates a new Disk instance using the specified properties.

Parameter
Name	Description
properties	IDisk Properties to set

Returns
Type	Description
Disk	Disk instance

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

Parameter
Name	Description
reader	(Reader|Uint8Array) Reader or buffer to decode from

Returns
Type	Description
Disk	Disk

encode(message, writer)

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

Encodes the specified Disk message. Does not implicitly messages.

Parameters
Name	Description
message	IDisk Disk 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.IDisk, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
message	IDisk Disk 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.Disk;

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

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Disk

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

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

toObject(message, options)

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

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

Parameters
Name	Description
message	Disk Disk
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 Disk 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