public final class AttachedDiskInitializeParams extends GeneratedMessageV3 implements AttachedDiskInitializeParamsOrBuilder
[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.
Protobuf type google.cloud.compute.v1.AttachedDiskInitializeParams
Fields
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISK_NAME_FIELD_NUMBER
public static final int DISK_NAME_FIELD_NUMBER
Field Value
DISK_SIZE_GB_FIELD_NUMBER
public static final int DISK_SIZE_GB_FIELD_NUMBER
Field Value
DISK_TYPE_FIELD_NUMBER
public static final int DISK_TYPE_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
ON_UPDATE_ACTION_FIELD_NUMBER
public static final int ON_UPDATE_ACTION_FIELD_NUMBER
Field Value
PROVISIONED_IOPS_FIELD_NUMBER
public static final int PROVISIONED_IOPS_FIELD_NUMBER
Field Value
RESOURCE_POLICIES_FIELD_NUMBER
public static final int RESOURCE_POLICIES_FIELD_NUMBER
Field Value
SOURCE_IMAGE_ENCRYPTION_KEY_FIELD_NUMBER
public static final int SOURCE_IMAGE_ENCRYPTION_KEY_FIELD_NUMBER
Field Value
SOURCE_IMAGE_FIELD_NUMBER
public static final int SOURCE_IMAGE_FIELD_NUMBER
Field Value
SOURCE_SNAPSHOT_ENCRYPTION_KEY_FIELD_NUMBER
public static final int SOURCE_SNAPSHOT_ENCRYPTION_KEY_FIELD_NUMBER
Field Value
SOURCE_SNAPSHOT_FIELD_NUMBER
public static final int SOURCE_SNAPSHOT_FIELD_NUMBER
Field Value
Methods
containsLabels(String key)
public 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;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstance()
public static AttachedDiskInitializeParams getDefaultInstance()
Returns
getDefaultInstanceForType()
public AttachedDiskInitializeParams getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
An optional description. Provide this property when creating the disk.
optional string description = 422937596;
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
An optional description. Provide this property when creating the disk.
optional string description = 422937596;
| Type | Description |
| ByteString | The bytes for description.
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getDiskName()
public 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 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;
getDiskSizeGb()
public 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 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 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;
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public 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;
getLabelsMap()
public 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;
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 disks.setLabels method. This field is only applicable for persistent disks.
map<string, string> labels = 500195327;
getLabelsOrThrow(String key)
public 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;
getOnUpdateAction()
public 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 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.
|
getParserForType()
public Parser<AttachedDiskInitializeParams> getParserForType()
Returns
Overrides
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;
| Type | Description |
| long | The provisionedIops.
|
getResourcePolicies(int index)
public 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.
|
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. 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.
|
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. 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 ProtocolStringList 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;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSourceImage()
public 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 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 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;
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. 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;
getSourceSnapshot()
public 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 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 CustomerEncryptionKey getSourceSnapshotEncryptionKey()
The customer-supplied encryption key of the source snapshot.
optional .google.cloud.compute.v1.CustomerEncryptionKey source_snapshot_encryption_key = 303679322;
getSourceSnapshotEncryptionKeyOrBuilder()
public CustomerEncryptionKeyOrBuilder getSourceSnapshotEncryptionKeyOrBuilder()
The customer-supplied encryption key of the source snapshot.
optional .google.cloud.compute.v1.CustomerEncryptionKey source_snapshot_encryption_key = 303679322;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasDescription()
public 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 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 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 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 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 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 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 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 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 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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static AttachedDiskInitializeParams.Builder newBuilder()
Returns
newBuilder(AttachedDiskInitializeParams prototype)
public static AttachedDiskInitializeParams.Builder newBuilder(AttachedDiskInitializeParams prototype)
Parameter
Returns
newBuilderForType()
public AttachedDiskInitializeParams.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AttachedDiskInitializeParams.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static AttachedDiskInitializeParams parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static AttachedDiskInitializeParams parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AttachedDiskInitializeParams parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AttachedDiskInitializeParams parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AttachedDiskInitializeParams parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AttachedDiskInitializeParams parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AttachedDiskInitializeParams parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static AttachedDiskInitializeParams parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AttachedDiskInitializeParams parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static AttachedDiskInitializeParams parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AttachedDiskInitializeParams parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AttachedDiskInitializeParams parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AttachedDiskInitializeParams> parser()
Returns
toBuilder()
public AttachedDiskInitializeParams.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
