- 1.65.0 (latest)
- 1.64.0
- 1.63.0
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public interface AttachedDiskInitializeParamsOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
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;
Name | Description |
key | String |
Type | Description |
boolean |
getDescription()
public abstract String getDescription()
An optional description. Provide this property when creating the disk.
optional string description = 422937596;
Type | Description |
String | The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()
An optional description. Provide this property when creating the disk.
optional string description = 422937596;
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;
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;
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;
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 define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
optional string disk_type = 93009052;
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 define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
optional string disk_type = 93009052;
Type | Description |
ByteString | The bytes for diskType. |
getLabels()
public abstract Map<String,String> getLabels()
Use #getLabelsMap() instead.
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;
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;
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;
Name | Description |
key | String |
defaultValue | String |
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;
Name | Description |
key | String |
Type | Description |
String |
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;
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;
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;
Type | Description |
long | The provisionedIops. |
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;
Name | Description |
index | int The index of the element to return. |
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;
Name | Description |
index | int The index of the value to return. |
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;
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;
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;
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;
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. Instance templates 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;
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. Instance templates 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;
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;
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;
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;
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;
Type | Description |
CustomerEncryptionKeyOrBuilder |
hasDescription()
public abstract boolean hasDescription()
An optional description. Provide this property when creating the disk.
optional string description = 422937596;
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;
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;
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 define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
optional string disk_type = 93009052;
Type | Description |
boolean | Whether the diskType 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;
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;
Type | Description |
boolean | Whether the provisionedIops 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;
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. Instance templates 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;
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;
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;
Type | Description |
boolean | Whether the sourceSnapshotEncryptionKey field is set. |