com.google.cloud.compute.v1

Interface AttachedDiskInitializeParamsOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

AttachedDiskInitializeParams, AttachedDiskInitializeParams.Builder

public interface AttachedDiskInitializeParamsOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Labels to apply to this disk.
boolean	containsResourceManagerTags(String key) Resource manager tags to be bound to the disk.
String	getArchitecture() The architecture of the attached disk.
com.google.protobuf.ByteString	getArchitectureBytes() The architecture of the attached disk.
String	getDescription() An optional description.
com.google.protobuf.ByteString	getDescriptionBytes() An optional description.
String	getDiskName() Specifies the disk name.
com.google.protobuf.ByteString	getDiskNameBytes() Specifies the disk name.
long	getDiskSizeGb() Specifies the size of the disk in base-2 GB.
String	getDiskType() Specifies the disk type to use to create the instance.
com.google.protobuf.ByteString	getDiskTypeBytes() Specifies the disk type to use to create the instance.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Labels to apply to this disk.
Map<String,String>	getLabelsMap() Labels to apply to this disk.
String	getLabelsOrDefault(String key, String defaultValue) Labels to apply to this disk.
String	getLabelsOrThrow(String key) Labels to apply to this disk.
String	getLicenses(int index) A list of publicly visible licenses.
com.google.protobuf.ByteString	getLicensesBytes(int index) A list of publicly visible licenses.
int	getLicensesCount() A list of publicly visible licenses.
List<String>	getLicensesList() A list of publicly visible licenses.
String	getOnUpdateAction() Specifies which action to take on instance update with this disk.
com.google.protobuf.ByteString	getOnUpdateActionBytes() Specifies which action to take on instance update with this disk.
long	getProvisionedIops() Indicates how many IOPS to provision for the disk.
Map<String,String>	getResourceManagerTags() Deprecated.
int	getResourceManagerTagsCount() Resource manager tags to be bound to the disk.
Map<String,String>	getResourceManagerTagsMap() Resource manager tags to be bound to the disk.
String	getResourceManagerTagsOrDefault(String key, String defaultValue) Resource manager tags to be bound to the disk.
String	getResourceManagerTagsOrThrow(String key) Resource manager tags to be bound to the disk.
String	getResourcePolicies(int index) Resource policies applied to this disk for automatic snapshot creations.
com.google.protobuf.ByteString	getResourcePoliciesBytes(int index) Resource policies applied to this disk for automatic snapshot creations.
int	getResourcePoliciesCount() Resource policies applied to this disk for automatic snapshot creations.
List<String>	getResourcePoliciesList() Resource policies applied to this disk for automatic snapshot creations.
String	getSourceImage() The source image to create this disk.
com.google.protobuf.ByteString	getSourceImageBytes() The source image to create this disk.
CustomerEncryptionKey	getSourceImageEncryptionKey() The customer-supplied encryption key of the source image.
CustomerEncryptionKeyOrBuilder	getSourceImageEncryptionKeyOrBuilder() The customer-supplied encryption key of the source image.
String	getSourceSnapshot() The source snapshot to create this disk.
com.google.protobuf.ByteString	getSourceSnapshotBytes() The source snapshot to create this disk.
CustomerEncryptionKey	getSourceSnapshotEncryptionKey() The customer-supplied encryption key of the source snapshot.
CustomerEncryptionKeyOrBuilder	getSourceSnapshotEncryptionKeyOrBuilder() The customer-supplied encryption key of the source snapshot.
boolean	hasArchitecture() The architecture of the attached disk.
boolean	hasDescription() An optional description.
boolean	hasDiskName() Specifies the disk name.
boolean	hasDiskSizeGb() Specifies the size of the disk in base-2 GB.
boolean	hasDiskType() Specifies the disk type to use to create the instance.
boolean	hasOnUpdateAction() Specifies which action to take on instance update with this disk.
boolean	hasProvisionedIops() Indicates how many IOPS to provision for the disk.
boolean	hasSourceImage() The source image to create this disk.
boolean	hasSourceImageEncryptionKey() The customer-supplied encryption key of the source image.
boolean	hasSourceSnapshot() The source snapshot to create this disk.
boolean	hasSourceSnapshotEncryptionKey() The customer-supplied encryption key of the source snapshot.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasArchitecture

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:

Whether the architecture field is set.

getArchitecture

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:

The architecture.

getArchitectureBytes

com.google.protobuf.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:

The bytes for architecture.

hasDescription

boolean hasDescription()

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

optional string description = 422937596;

Returns:

Whether the description field is set.

getDescription

String getDescription()

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

optional string description = 422937596;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns:

The bytes for description.

hasDiskName

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:

Whether the diskName field is set.

getDiskName

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:

The diskName.

getDiskNameBytes

com.google.protobuf.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:

The bytes for diskName.

hasDiskSizeGb

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:

Whether the diskSizeGb field is set.

getDiskSizeGb

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:

The diskSizeGb.

hasDiskType

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:

Whether the diskType field is set.

getDiskType

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:

The diskType.

getDiskTypeBytes

com.google.protobuf.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:

The bytes for diskType.

getLabelsCount

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;

containsLabels

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;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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 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 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;

getLicensesList

List<String> getLicensesList()

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

repeated string licenses = 337642578;

Returns:

A list containing the licenses.

getLicensesCount

int getLicensesCount()

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

repeated string licenses = 337642578;

Returns:

The count of licenses.

getLicenses

String getLicenses(int index)

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

repeated string licenses = 337642578;

Parameters:

index - The index of the element to return.

Returns:

The licenses at the given index.

getLicensesBytes

com.google.protobuf.ByteString getLicensesBytes(int index)

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

repeated string licenses = 337642578;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the licenses at the given index.

hasOnUpdateAction

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:

Whether the onUpdateAction field is set.

getOnUpdateAction

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:

The onUpdateAction.

getOnUpdateActionBytes

com.google.protobuf.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:

The bytes for onUpdateAction.

hasProvisionedIops

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:

Whether the provisionedIops field is set.

getProvisionedIops

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:

The provisionedIops.

getResourceManagerTagsCount

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;

containsResourceManagerTags

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;

getResourceManagerTags

@Deprecated
Map<String,String> getResourceManagerTags()

Deprecated.

Use getResourceManagerTagsMap() instead.

getResourceManagerTagsMap

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;

getResourceManagerTagsOrDefault

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;

getResourceManagerTagsOrThrow

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;

getResourcePoliciesList

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:

A list containing the resourcePolicies.

getResourcePoliciesCount

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:

The count of resourcePolicies.

getResourcePolicies

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;

Parameters:

index - The index of the element to return.

Returns:

The resourcePolicies at the given index.

getResourcePoliciesBytes

com.google.protobuf.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;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the resourcePolicies at the given index.

hasSourceImage

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:

Whether the sourceImage field is set.

getSourceImage

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:

The sourceImage.

getSourceImageBytes

com.google.protobuf.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:

The bytes for sourceImage.

hasSourceImageEncryptionKey

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:

Whether the sourceImageEncryptionKey field is set.

getSourceImageEncryptionKey

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:

The sourceImageEncryptionKey.

getSourceImageEncryptionKeyOrBuilder

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;

hasSourceSnapshot

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:

Whether the sourceSnapshot field is set.

getSourceSnapshot

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:

The sourceSnapshot.

getSourceSnapshotBytes

com.google.protobuf.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:

The bytes for sourceSnapshot.

hasSourceSnapshotEncryptionKey

boolean hasSourceSnapshotEncryptionKey()

 The customer-supplied encryption key of the source snapshot.
 

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

Returns:

Whether the sourceSnapshotEncryptionKey field is set.

getSourceSnapshotEncryptionKey

CustomerEncryptionKey getSourceSnapshotEncryptionKey()

 The customer-supplied encryption key of the source snapshot.
 

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

Returns:

The sourceSnapshotEncryptionKey.

getSourceSnapshotEncryptionKeyOrBuilder

CustomerEncryptionKeyOrBuilder getSourceSnapshotEncryptionKeyOrBuilder()

 The customer-supplied encryption key of the source snapshot.
 

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