Class Disk (1.64.0) 

public final class Disk extends GeneratedMessageV3 implements DiskOrBuilder

Represents a Persistent Disk resource. Google Compute Engine has two Disk resources: * Zonal * Regional Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources.

Protobuf type google.cloud.compute.v1.Disk

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Disk

Implements

DiskOrBuilder

Static Fields

ACCESS_MODE_FIELD_NUMBER

public static final int ACCESS_MODE_FIELD_NUMBER
Field Value
Type Description
int

ARCHITECTURE_FIELD_NUMBER

public static final int ARCHITECTURE_FIELD_NUMBER
Field Value
Type Description
int

ASYNC_PRIMARY_DISK_FIELD_NUMBER

public static final int ASYNC_PRIMARY_DISK_FIELD_NUMBER
Field Value
Type Description
int

ASYNC_SECONDARY_DISKS_FIELD_NUMBER

public static final int ASYNC_SECONDARY_DISKS_FIELD_NUMBER
Field Value
Type Description
int

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISK_ENCRYPTION_KEY_FIELD_NUMBER

public static final int DISK_ENCRYPTION_KEY_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_CONFIDENTIAL_COMPUTE_FIELD_NUMBER

public static final int ENABLE_CONFIDENTIAL_COMPUTE_FIELD_NUMBER
Field Value
Type Description
int

GUEST_OS_FEATURES_FIELD_NUMBER

public static final int GUEST_OS_FEATURES_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

LABEL_FINGERPRINT_FIELD_NUMBER

public static final int LABEL_FINGERPRINT_FIELD_NUMBER
Field Value
Type Description
int

LAST_ATTACH_TIMESTAMP_FIELD_NUMBER

public static final int LAST_ATTACH_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

LAST_DETACH_TIMESTAMP_FIELD_NUMBER

public static final int LAST_DETACH_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

LICENSES_FIELD_NUMBER

public static final int LICENSES_FIELD_NUMBER
Field Value
Type Description
int

LICENSE_CODES_FIELD_NUMBER

public static final int LICENSE_CODES_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_HINT_FIELD_NUMBER

public static final int LOCATION_HINT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

PARAMS_FIELD_NUMBER

public static final int PARAMS_FIELD_NUMBER
Field Value
Type Description
int

PHYSICAL_BLOCK_SIZE_BYTES_FIELD_NUMBER

public static final int PHYSICAL_BLOCK_SIZE_BYTES_FIELD_NUMBER
Field Value
Type Description
int

PROVISIONED_IOPS_FIELD_NUMBER

public static final int PROVISIONED_IOPS_FIELD_NUMBER
Field Value
Type Description
int

PROVISIONED_THROUGHPUT_FIELD_NUMBER

public static final int PROVISIONED_THROUGHPUT_FIELD_NUMBER
Field Value
Type Description
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER
Field Value
Type Description
int

REPLICA_ZONES_FIELD_NUMBER

public static final int REPLICA_ZONES_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_POLICIES_FIELD_NUMBER

public static final int RESOURCE_POLICIES_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_STATUS_FIELD_NUMBER

public static final int RESOURCE_STATUS_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZI_FIELD_NUMBER

public static final int SATISFIES_PZI_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value
Type Description
int 
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Type Description
int

SIZE_GB_FIELD_NUMBER

public static final int SIZE_GB_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_CONSISTENCY_GROUP_POLICY_FIELD_NUMBER

public static final int SOURCE_CONSISTENCY_GROUP_POLICY_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_CONSISTENCY_GROUP_POLICY_ID_FIELD_NUMBER

public static final int SOURCE_CONSISTENCY_GROUP_POLICY_ID_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_DISK_FIELD_NUMBER

public static final int SOURCE_DISK_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_DISK_ID_FIELD_NUMBER

public static final int SOURCE_DISK_ID_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_IMAGE_ENCRYPTION_KEY_FIELD_NUMBER

public static final int SOURCE_IMAGE_ENCRYPTION_KEY_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_IMAGE_FIELD_NUMBER

public static final int SOURCE_IMAGE_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_IMAGE_ID_FIELD_NUMBER

public static final int SOURCE_IMAGE_ID_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_INSTANT_SNAPSHOT_FIELD_NUMBER

public static final int SOURCE_INSTANT_SNAPSHOT_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_INSTANT_SNAPSHOT_ID_FIELD_NUMBER

public static final int SOURCE_INSTANT_SNAPSHOT_ID_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_SNAPSHOT_ENCRYPTION_KEY_FIELD_NUMBER

public static final int SOURCE_SNAPSHOT_ENCRYPTION_KEY_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_SNAPSHOT_FIELD_NUMBER

public static final int SOURCE_SNAPSHOT_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_SNAPSHOT_ID_FIELD_NUMBER

public static final int SOURCE_SNAPSHOT_ID_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_STORAGE_OBJECT_FIELD_NUMBER

public static final int SOURCE_STORAGE_OBJECT_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

STORAGE_POOL_FIELD_NUMBER

public static final int STORAGE_POOL_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

USERS_FIELD_NUMBER

public static final int USERS_FIELD_NUMBER
Field Value
Type Description
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Disk getDefaultInstance()
Returns
Type Description
Disk

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Disk.Builder newBuilder()
Returns
Type Description
Disk.Builder

newBuilder(Disk prototype)

public static Disk.Builder newBuilder(Disk prototype)
Parameter
Name Description
prototype Disk
Returns
Type Description
Disk.Builder

parseDelimitedFrom(InputStream input)

public static Disk parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Disk
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Disk parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Disk
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Disk parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Disk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Disk parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Disk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Disk parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Disk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Disk parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Disk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Disk parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Disk
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Disk parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Disk
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Disk parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Disk
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Disk parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Disk
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Disk parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Disk
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Disk parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Disk
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Disk> parser()
Returns
Type Description
Parser<Disk>

Methods

containsAsyncSecondaryDisks(String key)

public boolean containsAsyncSecondaryDisks(String key)

[Output Only] A list of disks this disk is asynchronously replicated to.

map<string, .google.cloud.compute.v1.DiskAsyncReplicationList> async_secondary_disks = 322925608;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsLabels(String key)

public boolean containsLabels(String key)

Labels to apply to this disk. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAccessMode()

public String getAccessMode()

The access mode of the disk. - READ_WRITE_SINGLE: The default AccessMode, means the disk can be attached to single instance in RW mode. - READ_WRITE_MANY: The AccessMode means the disk can be attached to multiple instances in RW mode. - READ_ONLY_MANY: The AccessMode means the disk can be attached to multiple instances in RO mode. The AccessMode is only valid for Hyperdisk disk types. Check the AccessMode enum for the list of possible values.

optional string access_mode = 41155486;

Returns
Type Description
String

The accessMode.

getAccessModeBytes()

public ByteString getAccessModeBytes()

The access mode of the disk. - READ_WRITE_SINGLE: The default AccessMode, means the disk can be attached to single instance in RW mode. - READ_WRITE_MANY: The AccessMode means the disk can be attached to multiple instances in RW mode. - READ_ONLY_MANY: The AccessMode means the disk can be attached to multiple instances in RO mode. The AccessMode is only valid for Hyperdisk disk types. Check the AccessMode enum for the list of possible values.

optional string access_mode = 41155486;

Returns
Type Description
ByteString

The bytes for accessMode.

getArchitecture()

public String getArchitecture()

The architecture of the disk. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

optional string architecture = 302803283;

Returns
Type Description
String

The architecture.

getArchitectureBytes()

public ByteString getArchitectureBytes()

The architecture of the disk. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

optional string architecture = 302803283;

Returns
Type Description
ByteString

The bytes for architecture.

getAsyncPrimaryDisk()

public DiskAsyncReplication getAsyncPrimaryDisk()

Disk asynchronously replicated into this disk.

optional .google.cloud.compute.v1.DiskAsyncReplication async_primary_disk = 180517533;

Returns
Type Description
DiskAsyncReplication

The asyncPrimaryDisk.

getAsyncPrimaryDiskOrBuilder()

public DiskAsyncReplicationOrBuilder getAsyncPrimaryDiskOrBuilder()

Disk asynchronously replicated into this disk.

optional .google.cloud.compute.v1.DiskAsyncReplication async_primary_disk = 180517533;

Returns
Type Description
DiskAsyncReplicationOrBuilder

getAsyncSecondaryDisks() (deprecated)

public Map<String,DiskAsyncReplicationList> getAsyncSecondaryDisks()

Use #getAsyncSecondaryDisksMap() instead.

Returns
Type Description
Map<String,DiskAsyncReplicationList>

getAsyncSecondaryDisksCount()

public int getAsyncSecondaryDisksCount()

[Output Only] A list of disks this disk is asynchronously replicated to.

map<string, .google.cloud.compute.v1.DiskAsyncReplicationList> async_secondary_disks = 322925608;

Returns
Type Description
int

getAsyncSecondaryDisksMap()

public Map<String,DiskAsyncReplicationList> getAsyncSecondaryDisksMap()

[Output Only] A list of disks this disk is asynchronously replicated to.

map<string, .google.cloud.compute.v1.DiskAsyncReplicationList> async_secondary_disks = 322925608;

Returns
Type Description
Map<String,DiskAsyncReplicationList>

getAsyncSecondaryDisksOrDefault(String key, DiskAsyncReplicationList defaultValue)

public DiskAsyncReplicationList getAsyncSecondaryDisksOrDefault(String key, DiskAsyncReplicationList defaultValue)

[Output Only] A list of disks this disk is asynchronously replicated to.

map<string, .google.cloud.compute.v1.DiskAsyncReplicationList> async_secondary_disks = 322925608;

Parameters
Name Description
key String
defaultValue DiskAsyncReplicationList
Returns
Type Description
DiskAsyncReplicationList

getAsyncSecondaryDisksOrThrow(String key)

public DiskAsyncReplicationList getAsyncSecondaryDisksOrThrow(String key)

[Output Only] A list of disks this disk is asynchronously replicated to.

map<string, .google.cloud.compute.v1.DiskAsyncReplicationList> async_secondary_disks = 322925608;

Parameter
Name Description
key String
Returns
Type Description
DiskAsyncReplicationList

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public Disk getDefaultInstanceForType()
Returns
Type Description
Disk

getDescription()

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDiskEncryptionKey()

public CustomerEncryptionKey getDiskEncryptionKey()

Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format: "diskEncryptionKey.kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later.

optional .google.cloud.compute.v1.CustomerEncryptionKey disk_encryption_key = 271660677;

Returns
Type Description
CustomerEncryptionKey

The diskEncryptionKey.

getDiskEncryptionKeyOrBuilder()

public CustomerEncryptionKeyOrBuilder getDiskEncryptionKeyOrBuilder()

Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format: "diskEncryptionKey.kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later.

optional .google.cloud.compute.v1.CustomerEncryptionKey disk_encryption_key = 271660677;

Returns
Type Description
CustomerEncryptionKeyOrBuilder

getEnableConfidentialCompute()

public boolean getEnableConfidentialCompute()

Whether this disk is using confidential compute mode.

optional bool enable_confidential_compute = 102135228;

Returns
Type Description
boolean

The enableConfidentialCompute.

getGuestOsFeatures(int index)

public GuestOsFeature getGuestOsFeatures(int index)

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

Parameter
Name Description
index int
Returns
Type Description
GuestOsFeature

getGuestOsFeaturesCount()

public int getGuestOsFeaturesCount()

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

Returns
Type Description
int

getGuestOsFeaturesList()

public List<GuestOsFeature> getGuestOsFeaturesList()

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

Returns
Type Description
List<GuestOsFeature>

getGuestOsFeaturesOrBuilder(int index)

public GuestOsFeatureOrBuilder getGuestOsFeaturesOrBuilder(int index)

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

Parameter
Name Description
index int
Returns
Type Description
GuestOsFeatureOrBuilder

getGuestOsFeaturesOrBuilderList()

public List<? extends GuestOsFeatureOrBuilder> getGuestOsFeaturesOrBuilderList()

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.GuestOsFeatureOrBuilder>

getId()

public long getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getKind()

public String getKind()

[Output Only] Type of the resource. Always compute#disk for disks.

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#disk for disks.

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

getLabelFingerprint()

public String getLabelFingerprint()

A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.

optional string label_fingerprint = 178124825;

Returns
Type Description
String

The labelFingerprint.

getLabelFingerprintBytes()

public ByteString getLabelFingerprintBytes()

A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.

optional string label_fingerprint = 178124825;

Returns
Type Description
ByteString

The bytes for labelFingerprint.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels to apply to this disk. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels to apply to this disk. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels to apply to this disk. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels to apply to this disk. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
String

getLastAttachTimestamp()

public String getLastAttachTimestamp()

[Output Only] Last attach timestamp in RFC3339 text format.

optional string last_attach_timestamp = 42159653;

Returns
Type Description
String

The lastAttachTimestamp.

getLastAttachTimestampBytes()

public ByteString getLastAttachTimestampBytes()

[Output Only] Last attach timestamp in RFC3339 text format.

optional string last_attach_timestamp = 42159653;

Returns
Type Description
ByteString

The bytes for lastAttachTimestamp.

getLastDetachTimestamp()

public String getLastDetachTimestamp()

[Output Only] Last detach timestamp in RFC3339 text format.

optional string last_detach_timestamp = 56471027;

Returns
Type Description
String

The lastDetachTimestamp.

getLastDetachTimestampBytes()

public ByteString getLastDetachTimestampBytes()

[Output Only] Last detach timestamp in RFC3339 text format.

optional string last_detach_timestamp = 56471027;

Returns
Type Description
ByteString

The bytes for lastDetachTimestamp.

getLicenseCodes(int index)

public long getLicenseCodes(int index)

Integer license codes indicating which licenses are attached to this disk.

repeated int64 license_codes = 45482664;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
long

The licenseCodes at the given index.

getLicenseCodesCount()

public int getLicenseCodesCount()

Integer license codes indicating which licenses are attached to this disk.

repeated int64 license_codes = 45482664;

Returns
Type Description
int

The count of licenseCodes.

getLicenseCodesList()

public List<Long> getLicenseCodesList()

Integer license codes indicating which licenses are attached to this disk.

repeated int64 license_codes = 45482664;

Returns
Type Description
List<Long>

A list containing the licenseCodes.

getLicenses(int index)

public String getLicenses(int index)

A list of publicly visible licenses. Reserved for Google's use.

repeated string licenses = 337642578;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The licenses at the given index.

getLicensesBytes(int index)

public ByteString getLicensesBytes(int index)

A list of publicly visible licenses. Reserved for Google's use.

repeated string licenses = 337642578;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the licenses at the given index.

getLicensesCount()

public int getLicensesCount()

A list of publicly visible licenses. Reserved for Google's use.

repeated string licenses = 337642578;

Returns
Type Description
int

The count of licenses.

getLicensesList()

public ProtocolStringList getLicensesList()

A list of publicly visible licenses. Reserved for Google's use.

repeated string licenses = 337642578;

Returns
Type Description
ProtocolStringList

A list containing the licenses.

getLocationHint()

public String getLocationHint()

An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API.

optional string location_hint = 350519505;

Returns
Type Description
String

The locationHint.

getLocationHintBytes()

public ByteString getLocationHintBytes()

An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API.

optional string location_hint = 350519505;

Returns
Type Description
ByteString

The bytes for locationHint.

getName()

public String getName()

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

getOptions()

public String getOptions()

Internal use only.

optional string options = 361137822;

Returns
Type Description
String

The options.

getOptionsBytes()

public ByteString getOptionsBytes()

Internal use only.

optional string options = 361137822;

Returns
Type Description
ByteString

The bytes for options.

getParams()

public DiskParams getParams()

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

optional .google.cloud.compute.v1.DiskParams params = 78313862;

Returns
Type Description
DiskParams

The params.

getParamsOrBuilder()

public DiskParamsOrBuilder getParamsOrBuilder()

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

optional .google.cloud.compute.v1.DiskParams params = 78313862;

Returns
Type Description
DiskParamsOrBuilder

getParserForType()

public Parser<Disk> getParserForType()
Returns
Type Description
Parser<Disk>
Overrides

getPhysicalBlockSizeBytes()

public long getPhysicalBlockSizeBytes()

Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.

optional int64 physical_block_size_bytes = 420007943;

Returns
Type Description
long

The physicalBlockSizeBytes.

getProvisionedIops()

public long getProvisionedIops()

Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.

optional int64 provisioned_iops = 186769108;

Returns
Type Description
long

The provisionedIops.

getProvisionedThroughput()

public long getProvisionedThroughput()

Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1.

optional int64 provisioned_throughput = 526524181;

Returns
Type Description
long

The provisionedThroughput.

getRegion()

public String getRegion()

[Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

optional string region = 138946292;

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

[Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

optional string region = 138946292;

Returns
Type Description
ByteString

The bytes for region.

getReplicaZones(int index)

public String getReplicaZones(int index)

URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

repeated string replica_zones = 48438272;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The replicaZones at the given index.

getReplicaZonesBytes(int index)

public ByteString getReplicaZonesBytes(int index)

URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

repeated string replica_zones = 48438272;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the replicaZones at the given index.

getReplicaZonesCount()

public int getReplicaZonesCount()

URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

repeated string replica_zones = 48438272;

Returns
Type Description
int

The count of replicaZones.

getReplicaZonesList()

public ProtocolStringList getReplicaZonesList()

URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

repeated string replica_zones = 48438272;

Returns
Type Description
ProtocolStringList

A list containing the replicaZones.

getResourcePolicies(int index)

public String getResourcePolicies(int index)

Resource policies applied to this disk for automatic snapshot creations.

repeated string resource_policies = 22220385;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The resourcePolicies at the given index.

getResourcePoliciesBytes(int index)

public ByteString getResourcePoliciesBytes(int index)

Resource policies applied to this disk for automatic snapshot creations.

repeated string resource_policies = 22220385;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the resourcePolicies at the given index.

getResourcePoliciesCount()

public int getResourcePoliciesCount()

Resource policies applied to this disk for automatic snapshot creations.

repeated string resource_policies = 22220385;

Returns
Type Description
int

The count of resourcePolicies.

getResourcePoliciesList()

public ProtocolStringList getResourcePoliciesList()

Resource policies applied to this disk for automatic snapshot creations.

repeated string resource_policies = 22220385;

Returns
Type Description
ProtocolStringList

A list containing the resourcePolicies.

getResourceStatus()

public DiskResourceStatus getResourceStatus()

[Output Only] Status information for the disk resource.

optional .google.cloud.compute.v1.DiskResourceStatus resource_status = 249429315;

Returns
Type Description
DiskResourceStatus

The resourceStatus.

getResourceStatusOrBuilder()

public DiskResourceStatusOrBuilder getResourceStatusOrBuilder()

[Output Only] Status information for the disk resource.

optional .google.cloud.compute.v1.DiskResourceStatus resource_status = 249429315;

Returns
Type Description
DiskResourceStatusOrBuilder

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. Reserved for future use.

optional bool satisfies_pzi = 480964257;

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type Description
boolean

The satisfiesPzs.

getSelfLink()

public String getSelfLink()

[Output Only] Server-defined fully-qualified URL for this resource.

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output Only] Server-defined fully-qualified URL for this resource.

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSizeGb()

public long getSizeGb()

Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are greater than 0.

optional int64 size_gb = 494929369;

Returns
Type Description
long

The sizeGb.

getSourceConsistencyGroupPolicy()

public String getSourceConsistencyGroupPolicy()

[Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.

optional string source_consistency_group_policy = 19616093;

Returns
Type Description
String

The sourceConsistencyGroupPolicy.

getSourceConsistencyGroupPolicyBytes()

public ByteString getSourceConsistencyGroupPolicyBytes()

[Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.

optional string source_consistency_group_policy = 19616093;

Returns
Type Description
ByteString

The bytes for sourceConsistencyGroupPolicy.

getSourceConsistencyGroupPolicyId()

public String getSourceConsistencyGroupPolicyId()

[Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.

optional string source_consistency_group_policy_id = 267568957;

Returns
Type Description
String

The sourceConsistencyGroupPolicyId.

getSourceConsistencyGroupPolicyIdBytes()

public ByteString getSourceConsistencyGroupPolicyIdBytes()

[Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.

optional string source_consistency_group_policy_id = 267568957;

Returns
Type Description
ByteString

The bytes for sourceConsistencyGroupPolicyId.

getSourceDisk()

public String getSourceDisk()

The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk

optional string source_disk = 451753793;

Returns
Type Description
String

The sourceDisk.

getSourceDiskBytes()

public ByteString getSourceDiskBytes()

The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk

optional string source_disk = 451753793;

Returns
Type Description
ByteString

The bytes for sourceDisk.

getSourceDiskId()

public String getSourceDiskId()

[Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.

optional string source_disk_id = 454190809;

Returns
Type Description
String

The sourceDiskId.

getSourceDiskIdBytes()

public ByteString getSourceDiskIdBytes()

[Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.

optional string source_disk_id = 454190809;

Returns
Type Description
ByteString

The bytes for sourceDiskId.

getSourceImage()

public String getSourceImage()

The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family

optional string source_image = 50443319;

Returns
Type Description
String

The sourceImage.

getSourceImageBytes()

public ByteString getSourceImageBytes()

The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family

optional string source_image = 50443319;

Returns
Type Description
ByteString

The bytes for sourceImage.

getSourceImageEncryptionKey()

public CustomerEncryptionKey getSourceImageEncryptionKey()

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_image_encryption_key = 381503659;

Returns
Type Description
CustomerEncryptionKey

The sourceImageEncryptionKey.

getSourceImageEncryptionKeyOrBuilder()

public CustomerEncryptionKeyOrBuilder getSourceImageEncryptionKeyOrBuilder()

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_image_encryption_key = 381503659;

Returns
Type Description
CustomerEncryptionKeyOrBuilder

getSourceImageId()

public String getSourceImageId()

[Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.

optional string source_image_id = 55328291;

Returns
Type Description
String

The sourceImageId.

getSourceImageIdBytes()

public ByteString getSourceImageIdBytes()

[Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.

optional string source_image_id = 55328291;

Returns
Type Description
ByteString

The bytes for sourceImageId.

getSourceInstantSnapshot()

public String getSourceInstantSnapshot()

The source instant snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot

optional string source_instant_snapshot = 219202054;

Returns
Type Description
String

The sourceInstantSnapshot.

getSourceInstantSnapshotBytes()

public ByteString getSourceInstantSnapshotBytes()

The source instant snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot

optional string source_instant_snapshot = 219202054;

Returns
Type Description
ByteString

The bytes for sourceInstantSnapshot.

getSourceInstantSnapshotId()

public String getSourceInstantSnapshotId()

[Output Only] The unique ID of the instant snapshot used to create this disk. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact version of the instant snapshot that was used.

optional string source_instant_snapshot_id = 287582708;

Returns
Type Description
String

The sourceInstantSnapshotId.

getSourceInstantSnapshotIdBytes()

public ByteString getSourceInstantSnapshotIdBytes()

[Output Only] The unique ID of the instant snapshot used to create this disk. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact version of the instant snapshot that was used.

optional string source_instant_snapshot_id = 287582708;

Returns
Type Description
ByteString

The bytes for sourceInstantSnapshotId.

getSourceSnapshot()

public String getSourceSnapshot()

The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot

optional string source_snapshot = 126061928;

Returns
Type Description
String

The sourceSnapshot.

getSourceSnapshotBytes()

public ByteString getSourceSnapshotBytes()

The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot

optional string source_snapshot = 126061928;

Returns
Type Description
ByteString

The bytes for sourceSnapshot.

getSourceSnapshotEncryptionKey()

public CustomerEncryptionKey getSourceSnapshotEncryptionKey()

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_snapshot_encryption_key = 303679322;

Returns
Type Description
CustomerEncryptionKey

The sourceSnapshotEncryptionKey.

getSourceSnapshotEncryptionKeyOrBuilder()

public CustomerEncryptionKeyOrBuilder getSourceSnapshotEncryptionKeyOrBuilder()

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_snapshot_encryption_key = 303679322;

Returns
Type Description
CustomerEncryptionKeyOrBuilder

getSourceSnapshotId()

public String getSourceSnapshotId()

[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.

optional string source_snapshot_id = 98962258;

Returns
Type Description
String

The sourceSnapshotId.

getSourceSnapshotIdBytes()

public ByteString getSourceSnapshotIdBytes()

[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.

optional string source_snapshot_id = 98962258;

Returns
Type Description
ByteString

The bytes for sourceSnapshotId.

getSourceStorageObject()

public String getSourceStorageObject()

The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.

optional string source_storage_object = 233052711;

Returns
Type Description
String

The sourceStorageObject.

getSourceStorageObjectBytes()

public ByteString getSourceStorageObjectBytes()

The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.

optional string source_storage_object = 233052711;

Returns
Type Description
ByteString

The bytes for sourceStorageObject.

getStatus()

public String getStatus()

[Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
String

The status.

getStatusBytes()

public ByteString getStatusBytes()

[Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
ByteString

The bytes for status.

getStoragePool()

public String getStoragePool()

The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool

optional string storage_pool = 360473440;

Returns
Type Description
String

The storagePool.

getStoragePoolBytes()

public ByteString getStoragePoolBytes()

The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool

optional string storage_pool = 360473440;

Returns
Type Description
ByteString

The bytes for storagePool.

getType()

public String getType()

URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types.

optional string type = 3575610;

Returns
Type Description
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types.

optional string type = 3575610;

Returns
Type Description
ByteString

The bytes for type.

getUsers(int index)

public String getUsers(int index)

[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance

repeated string users = 111578632;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The users at the given index.

getUsersBytes(int index)

public ByteString getUsersBytes(int index)

[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance

repeated string users = 111578632;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the users at the given index.

getUsersCount()

public int getUsersCount()

[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance

repeated string users = 111578632;

Returns
Type Description
int

The count of users.

getUsersList()

public ProtocolStringList getUsersList()

[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance

repeated string users = 111578632;

Returns
Type Description
ProtocolStringList

A list containing the users.

getZone()

public String getZone()

[Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

optional string zone = 3744684;

Returns
Type Description
String

The zone.

getZoneBytes()

public ByteString getZoneBytes()

[Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

optional string zone = 3744684;

Returns
Type Description
ByteString

The bytes for zone.

hasAccessMode()

public boolean hasAccessMode()

The access mode of the disk. - READ_WRITE_SINGLE: The default AccessMode, means the disk can be attached to single instance in RW mode. - READ_WRITE_MANY: The AccessMode means the disk can be attached to multiple instances in RW mode. - READ_ONLY_MANY: The AccessMode means the disk can be attached to multiple instances in RO mode. The AccessMode is only valid for Hyperdisk disk types. Check the AccessMode enum for the list of possible values.

optional string access_mode = 41155486;

Returns
Type Description
boolean

Whether the accessMode field is set.

hasArchitecture()

public boolean hasArchitecture()

The architecture of the disk. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

optional string architecture = 302803283;

Returns
Type Description
boolean

Whether the architecture field is set.

hasAsyncPrimaryDisk()

public boolean hasAsyncPrimaryDisk()

Disk asynchronously replicated into this disk.

optional .google.cloud.compute.v1.DiskAsyncReplication async_primary_disk = 180517533;

Returns
Type Description
boolean

Whether the asyncPrimaryDisk field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasDiskEncryptionKey()

public boolean hasDiskEncryptionKey()

Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format: "diskEncryptionKey.kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later.

optional .google.cloud.compute.v1.CustomerEncryptionKey disk_encryption_key = 271660677;

Returns
Type Description
boolean

Whether the diskEncryptionKey field is set.

hasEnableConfidentialCompute()

public boolean hasEnableConfidentialCompute()

Whether this disk is using confidential compute mode.

optional bool enable_confidential_compute = 102135228;

Returns
Type Description
boolean

Whether the enableConfidentialCompute field is set.

hasId()

public boolean hasId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of the resource. Always compute#disk for disks.

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasLabelFingerprint()

public boolean hasLabelFingerprint()

A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.

optional string label_fingerprint = 178124825;

Returns
Type Description
boolean

Whether the labelFingerprint field is set.

hasLastAttachTimestamp()

public boolean hasLastAttachTimestamp()

[Output Only] Last attach timestamp in RFC3339 text format.

optional string last_attach_timestamp = 42159653;

Returns
Type Description
boolean

Whether the lastAttachTimestamp field is set.

hasLastDetachTimestamp()

public boolean hasLastDetachTimestamp()

[Output Only] Last detach timestamp in RFC3339 text format.

optional string last_detach_timestamp = 56471027;

Returns
Type Description
boolean

Whether the lastDetachTimestamp field is set.

hasLocationHint()

public boolean hasLocationHint()

An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API.

optional string location_hint = 350519505;

Returns
Type Description
boolean

Whether the locationHint field is set.

hasName()

public boolean hasName()

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasOptions()

public boolean hasOptions()

Internal use only.

optional string options = 361137822;

Returns
Type Description
boolean

Whether the options field is set.

hasParams()

public boolean hasParams()

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

optional .google.cloud.compute.v1.DiskParams params = 78313862;

Returns
Type Description
boolean

Whether the params field is set.

hasPhysicalBlockSizeBytes()

public boolean hasPhysicalBlockSizeBytes()

Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.

optional int64 physical_block_size_bytes = 420007943;

Returns
Type Description
boolean

Whether the physicalBlockSizeBytes field is set.

hasProvisionedIops()

public boolean hasProvisionedIops()

Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.

optional int64 provisioned_iops = 186769108;

Returns
Type Description
boolean

Whether the provisionedIops field is set.

hasProvisionedThroughput()

public boolean hasProvisionedThroughput()

Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1.

optional int64 provisioned_throughput = 526524181;

Returns
Type Description
boolean

Whether the provisionedThroughput field is set.

hasRegion()

public boolean hasRegion()

[Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

optional string region = 138946292;

Returns
Type Description
boolean

Whether the region field is set.

hasResourceStatus()

public boolean hasResourceStatus()

[Output Only] Status information for the disk resource.

optional .google.cloud.compute.v1.DiskResourceStatus resource_status = 249429315;

Returns
Type Description
boolean

Whether the resourceStatus field is set.

hasSatisfiesPzi()

public boolean hasSatisfiesPzi()

Output only. Reserved for future use.

optional bool satisfies_pzi = 480964257;

Returns
Type Description
boolean

Whether the satisfiesPzi field is set.

hasSatisfiesPzs()

public boolean hasSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type Description
boolean

Whether the satisfiesPzs field is set.

hasSelfLink()

public boolean hasSelfLink()

[Output Only] Server-defined fully-qualified URL for this resource.

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasSizeGb()

public boolean hasSizeGb()

Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are greater than 0.

optional int64 size_gb = 494929369;

Returns
Type Description
boolean

Whether the sizeGb field is set.

hasSourceConsistencyGroupPolicy()

public boolean hasSourceConsistencyGroupPolicy()

[Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.

optional string source_consistency_group_policy = 19616093;

Returns
Type Description
boolean

Whether the sourceConsistencyGroupPolicy field is set.

hasSourceConsistencyGroupPolicyId()

public boolean hasSourceConsistencyGroupPolicyId()

[Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.

optional string source_consistency_group_policy_id = 267568957;

Returns
Type Description
boolean

Whether the sourceConsistencyGroupPolicyId field is set.

hasSourceDisk()

public boolean hasSourceDisk()

The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk

optional string source_disk = 451753793;

Returns
Type Description
boolean

Whether the sourceDisk field is set.

hasSourceDiskId()

public boolean hasSourceDiskId()

[Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.

optional string source_disk_id = 454190809;

Returns
Type Description
boolean

Whether the sourceDiskId field is set.

hasSourceImage()

public boolean hasSourceImage()

The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family

optional string source_image = 50443319;

Returns
Type Description
boolean

Whether the sourceImage field is set.

hasSourceImageEncryptionKey()

public boolean hasSourceImageEncryptionKey()

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_image_encryption_key = 381503659;

Returns
Type Description
boolean

Whether the sourceImageEncryptionKey field is set.

hasSourceImageId()

public boolean hasSourceImageId()

[Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.

optional string source_image_id = 55328291;

Returns
Type Description
boolean

Whether the sourceImageId field is set.

hasSourceInstantSnapshot()

public boolean hasSourceInstantSnapshot()

The source instant snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot

optional string source_instant_snapshot = 219202054;

Returns
Type Description
boolean

Whether the sourceInstantSnapshot field is set.

hasSourceInstantSnapshotId()

public boolean hasSourceInstantSnapshotId()

[Output Only] The unique ID of the instant snapshot used to create this disk. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact version of the instant snapshot that was used.

optional string source_instant_snapshot_id = 287582708;

Returns
Type Description
boolean

Whether the sourceInstantSnapshotId field is set.

hasSourceSnapshot()

public boolean hasSourceSnapshot()

The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot

optional string source_snapshot = 126061928;

Returns
Type Description
boolean

Whether the sourceSnapshot field is set.

hasSourceSnapshotEncryptionKey()

public boolean hasSourceSnapshotEncryptionKey()

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_snapshot_encryption_key = 303679322;

Returns
Type Description
boolean

Whether the sourceSnapshotEncryptionKey field is set.

hasSourceSnapshotId()

public boolean hasSourceSnapshotId()

[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.

optional string source_snapshot_id = 98962258;

Returns
Type Description
boolean

Whether the sourceSnapshotId field is set.

hasSourceStorageObject()

public boolean hasSourceStorageObject()

The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.

optional string source_storage_object = 233052711;

Returns
Type Description
boolean

Whether the sourceStorageObject field is set.

hasStatus()

public boolean hasStatus()

[Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
boolean

Whether the status field is set.

hasStoragePool()

public boolean hasStoragePool()

The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool

optional string storage_pool = 360473440;

Returns
Type Description
boolean

Whether the storagePool field is set.

hasType()

public boolean hasType()

URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types.

optional string type = 3575610;

Returns
Type Description
boolean

Whether the type field is set.

hasZone()

public boolean hasZone()

[Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

optional string zone = 3744684;

Returns
Type Description
boolean

Whether the zone field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Disk.Builder newBuilderForType()
Returns
Type Description
Disk.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Disk.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Disk.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Disk.Builder toBuilder()
Returns
Type Description
Disk.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException