Interface AttachedDiskInitializeParamsOrBuilder (1.59.0) 

public interface AttachedDiskInitializeParamsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsResourceManagerTags(String key)

public abstract boolean containsResourceManagerTags(String key)

Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

map<string, string> resource_manager_tags = 377671164;

Parameter
Name Description
key String
Returns
Type Description
boolean

getArchitecture()

public abstract String getArchitecture()

The architecture of the attached 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 abstract ByteString getArchitectureBytes()

The architecture of the attached 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.

getDescription()

public abstract String getDescription()

An optional description. Provide this property when creating the disk.

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

An optional description. Provide this property when creating the disk.

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDiskName()

public abstract String getDiskName()

Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

optional string disk_name = 92807149;

Returns
Type Description
String

The diskName.

getDiskNameBytes()

public abstract ByteString getDiskNameBytes()

Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

optional string disk_name = 92807149;

Returns
Type Description
ByteString

The bytes for diskName.

getDiskSizeGb()

public abstract long getDiskSizeGb()

Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

optional int64 disk_size_gb = 316263735;

Returns
Type Description
long

The diskSizeGb.

getDiskType()

public abstract String getDiskType()

Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard.

optional string disk_type = 93009052;

Returns
Type Description
String

The diskType.

getDiskTypeBytes()

public abstract ByteString getDiskTypeBytes()

Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard.

optional string disk_type = 93009052;

Returns
Type Description
ByteString

The bytes for diskType.

getEnableConfidentialCompute()

public abstract boolean getEnableConfidentialCompute()

Whether this disk is using confidential compute mode.

optional bool enable_confidential_compute = 102135228;

Returns
Type Description
boolean

The enableConfidentialCompute.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

map<string, string> labels = 500195327;

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

map<string, string> labels = 500195327;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

map<string, string> labels = 500195327;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
String

getLicenses(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> getLicensesList()

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

repeated string licenses = 337642578;

Returns
Type Description
List<String>

A list containing the licenses.

getOnUpdateAction()

public abstract String getOnUpdateAction()

Specifies which action to take on instance update with this disk. Default is to use the existing disk. Check the OnUpdateAction enum for the list of possible values.

optional string on_update_action = 202451980;

Returns
Type Description
String

The onUpdateAction.

getOnUpdateActionBytes()

public abstract ByteString getOnUpdateActionBytes()

Specifies which action to take on instance update with this disk. Default is to use the existing disk. Check the OnUpdateAction enum for the list of possible values.

optional string on_update_action = 202451980;

Returns
Type Description
ByteString

The bytes for onUpdateAction.

getProvisionedIops()

public abstract 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 abstract 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 greater than or equal to 1.

optional int64 provisioned_throughput = 526524181;

Returns
Type Description
long

The provisionedThroughput.

getReplicaZones(int index)

public abstract String getReplicaZones(int index)

Required for each regional disk associated with the instance. Specify the URLs of the zones where the disk should be replicated to. You must provide exactly two replica zones, and one zone must be the same as the instance zone.

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 abstract ByteString getReplicaZonesBytes(int index)

Required for each regional disk associated with the instance. Specify the URLs of the zones where the disk should be replicated to. You must provide exactly two replica zones, and one zone must be the same as the instance zone.

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 abstract int getReplicaZonesCount()

Required for each regional disk associated with the instance. Specify the URLs of the zones where the disk should be replicated to. You must provide exactly two replica zones, and one zone must be the same as the instance zone.

repeated string replica_zones = 48438272;

Returns
Type Description
int

The count of replicaZones.

getReplicaZonesList()

public abstract List<String> getReplicaZonesList()

Required for each regional disk associated with the instance. Specify the URLs of the zones where the disk should be replicated to. You must provide exactly two replica zones, and one zone must be the same as the instance zone.

repeated string replica_zones = 48438272;

Returns
Type Description
List<String>

A list containing the replicaZones.

getResourceManagerTags() (deprecated)

public abstract Map<String,String> getResourceManagerTags()

Use #getResourceManagerTagsMap() instead.

Returns
Type Description
Map<String,String>

getResourceManagerTagsCount()

public abstract int getResourceManagerTagsCount()

Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

map<string, string> resource_manager_tags = 377671164;

Returns
Type Description
int

getResourceManagerTagsMap()

public abstract Map<String,String> getResourceManagerTagsMap()

Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

map<string, string> resource_manager_tags = 377671164;

Returns
Type Description
Map<String,String>

getResourceManagerTagsOrDefault(String key, String defaultValue)

public abstract String getResourceManagerTagsOrDefault(String key, String defaultValue)

Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

map<string, string> resource_manager_tags = 377671164;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getResourceManagerTagsOrThrow(String key)

public abstract String getResourceManagerTagsOrThrow(String key)

Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

map<string, string> resource_manager_tags = 377671164;

Parameter
Name Description
key String
Returns
Type Description
String

getResourcePolicies(int index)

public abstract String getResourcePolicies(int index)

Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

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 abstract ByteString getResourcePoliciesBytes(int index)

Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

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 abstract int getResourcePoliciesCount()

Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

repeated string resource_policies = 22220385;

Returns
Type Description
int

The count of resourcePolicies.

getResourcePoliciesList()

public abstract List<String> getResourcePoliciesList()

Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

repeated string resource_policies = 22220385;

Returns
Type Description
List<String>

A list containing the resourcePolicies.

getSourceImage()

public abstract String getSourceImage()

The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. 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 If the source image is deleted later, this field will not be set.

optional string source_image = 50443319;

Returns
Type Description
String

The sourceImage.

getSourceImageBytes()

public abstract ByteString getSourceImageBytes()

The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. 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 If the source image is deleted later, this field will not be set.

optional string source_image = 50443319;

Returns
Type Description
ByteString

The bytes for sourceImage.

getSourceImageEncryptionKey()

public abstract CustomerEncryptionKey getSourceImageEncryptionKey()

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. InstanceTemplate and InstancePropertiesPatch do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

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

Returns
Type Description
CustomerEncryptionKey

The sourceImageEncryptionKey.

getSourceImageEncryptionKeyOrBuilder()

public abstract CustomerEncryptionKeyOrBuilder getSourceImageEncryptionKeyOrBuilder()

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. InstanceTemplate and InstancePropertiesPatch do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

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

Returns
Type Description
CustomerEncryptionKeyOrBuilder

getSourceSnapshot()

public abstract String getSourceSnapshot()

The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

optional string source_snapshot = 126061928;

Returns
Type Description
String

The sourceSnapshot.

getSourceSnapshotBytes()

public abstract ByteString getSourceSnapshotBytes()

The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

optional string source_snapshot = 126061928;

Returns
Type Description
ByteString

The bytes for sourceSnapshot.

getSourceSnapshotEncryptionKey()

public abstract CustomerEncryptionKey getSourceSnapshotEncryptionKey()

The customer-supplied encryption key of the source snapshot.

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

Returns
Type Description
CustomerEncryptionKey

The sourceSnapshotEncryptionKey.

getSourceSnapshotEncryptionKeyOrBuilder()

public abstract CustomerEncryptionKeyOrBuilder getSourceSnapshotEncryptionKeyOrBuilder()

The customer-supplied encryption key of the source snapshot.

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

Returns
Type Description
CustomerEncryptionKeyOrBuilder

getStoragePool()

public abstract 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 abstract 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.

hasArchitecture()

public abstract boolean hasArchitecture()

The architecture of the attached 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.

hasDescription()

public abstract boolean hasDescription()

An optional description. Provide this property when creating the disk.

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasDiskName()

public abstract boolean hasDiskName()

Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

optional string disk_name = 92807149;

Returns
Type Description
boolean

Whether the diskName field is set.

hasDiskSizeGb()

public abstract boolean hasDiskSizeGb()

Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

optional int64 disk_size_gb = 316263735;

Returns
Type Description
boolean

Whether the diskSizeGb field is set.

hasDiskType()

public abstract boolean hasDiskType()

Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard.

optional string disk_type = 93009052;

Returns
Type Description
boolean

Whether the diskType field is set.

hasEnableConfidentialCompute()

public abstract 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.

hasOnUpdateAction()

public abstract boolean hasOnUpdateAction()

Specifies which action to take on instance update with this disk. Default is to use the existing disk. Check the OnUpdateAction enum for the list of possible values.

optional string on_update_action = 202451980;

Returns
Type Description
boolean

Whether the onUpdateAction field is set.

hasProvisionedIops()

public abstract 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 abstract 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 greater than or equal to 1.

optional int64 provisioned_throughput = 526524181;

Returns
Type Description
boolean

Whether the provisionedThroughput field is set.

hasSourceImage()

public abstract boolean hasSourceImage()

The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. 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 If the source image is deleted later, this field will not be set.

optional string source_image = 50443319;

Returns
Type Description
boolean

Whether the sourceImage field is set.

hasSourceImageEncryptionKey()

public abstract boolean hasSourceImageEncryptionKey()

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. InstanceTemplate and InstancePropertiesPatch do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

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

Returns
Type Description
boolean

Whether the sourceImageEncryptionKey field is set.

hasSourceSnapshot()

public abstract boolean hasSourceSnapshot()

The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

optional string source_snapshot = 126061928;

Returns
Type Description
boolean

Whether the sourceSnapshot field is set.

hasSourceSnapshotEncryptionKey()

public abstract boolean hasSourceSnapshotEncryptionKey()

The customer-supplied encryption key of the source snapshot.

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

Returns
Type Description
boolean

Whether the sourceSnapshotEncryptionKey field is set.

hasStoragePool()

public abstract 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.