- 1.63.0 (latest)
- 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 DiskOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract boolean containsLabels(String key)Labels to apply to this disk. These can be later modified by the setLabels method.
map<string, string> labels = 500195327;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getArchitecture()
public abstract String getArchitecture()The architecture of the disk. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.
optional string architecture = 302803283;
| Returns | |
|---|---|
| Type | Description |
String | The architecture. |
getArchitectureBytes()
public abstract ByteString getArchitectureBytes()The architecture of the disk. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.
optional string architecture = 302803283;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for architecture. |
getCreationTimestamp()
public abstract String getCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
String | The creationTimestamp. |
getCreationTimestampBytes()
public abstract ByteString getCreationTimestampBytes()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for creationTimestamp. |
getDescription()
public abstract String getDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
String | The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for description. |
getDiskEncryptionKey()
public abstract CustomerEncryptionKey getDiskEncryptionKey()Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format: "diskEncryptionKey.kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later.
optional .google.cloud.compute.v1.CustomerEncryptionKey disk_encryption_key = 271660677;
| Returns | |
|---|---|
| Type | Description |
CustomerEncryptionKey | The diskEncryptionKey. |
getDiskEncryptionKeyOrBuilder()
public abstract CustomerEncryptionKeyOrBuilder getDiskEncryptionKeyOrBuilder()Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format: "diskEncryptionKey.kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later.
optional .google.cloud.compute.v1.CustomerEncryptionKey disk_encryption_key = 271660677;
| Returns | |
|---|---|
| Type | Description |
CustomerEncryptionKeyOrBuilder | |
getGuestOsFeatures(int index)
public abstract GuestOsFeature getGuestOsFeatures(int index)A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
GuestOsFeature | |
getGuestOsFeaturesCount()
public abstract int getGuestOsFeaturesCount()A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;
| Returns | |
|---|---|
| Type | Description |
int | |
getGuestOsFeaturesList()
public abstract List<GuestOsFeature> getGuestOsFeaturesList()A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;
| Returns | |
|---|---|
| Type | Description |
List<GuestOsFeature> | |
getGuestOsFeaturesOrBuilder(int index)
public abstract GuestOsFeatureOrBuilder getGuestOsFeaturesOrBuilder(int index)A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
GuestOsFeatureOrBuilder | |
getGuestOsFeaturesOrBuilderList()
public abstract List<? extends GuestOsFeatureOrBuilder> getGuestOsFeaturesOrBuilderList()A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.compute.v1.GuestOsFeatureOrBuilder> | |
getId()
public abstract long getId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Returns | |
|---|---|
| Type | Description |
long | The id. |
getKind()
public abstract String getKind()[Output Only] Type of the resource. Always compute#disk for disks.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
String | The kind. |
getKindBytes()
public abstract ByteString getKindBytes()[Output Only] Type of the resource. Always compute#disk for disks.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for kind. |
getLabelFingerprint()
public abstract String getLabelFingerprint()A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.
optional string label_fingerprint = 178124825;
| Returns | |
|---|---|
| Type | Description |
String | The labelFingerprint. |
getLabelFingerprintBytes()
public abstract ByteString getLabelFingerprintBytes()A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.
optional string label_fingerprint = 178124825;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for labelFingerprint. |
getLabels()
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 setLabels method.
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 setLabels method.
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 setLabels method.
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 setLabels method.
map<string, string> labels = 500195327;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getLastAttachTimestamp()
public abstract String getLastAttachTimestamp()[Output Only] Last attach timestamp in RFC3339 text format.
optional string last_attach_timestamp = 42159653;
| Returns | |
|---|---|
| Type | Description |
String | The lastAttachTimestamp. |
getLastAttachTimestampBytes()
public abstract ByteString getLastAttachTimestampBytes()[Output Only] Last attach timestamp in RFC3339 text format.
optional string last_attach_timestamp = 42159653;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for lastAttachTimestamp. |
getLastDetachTimestamp()
public abstract String getLastDetachTimestamp()[Output Only] Last detach timestamp in RFC3339 text format.
optional string last_detach_timestamp = 56471027;
| Returns | |
|---|---|
| Type | Description |
String | The lastDetachTimestamp. |
getLastDetachTimestampBytes()
public abstract ByteString getLastDetachTimestampBytes()[Output Only] Last detach timestamp in RFC3339 text format.
optional string last_detach_timestamp = 56471027;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for lastDetachTimestamp. |
getLicenseCodes(int index)
public abstract long getLicenseCodes(int index)Integer license codes indicating which licenses are attached to this disk.
repeated int64 license_codes = 45482664;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
long | The licenseCodes at the given index. |
getLicenseCodesCount()
public abstract int getLicenseCodesCount()Integer license codes indicating which licenses are attached to this disk.
repeated int64 license_codes = 45482664;
| Returns | |
|---|---|
| Type | Description |
int | The count of licenseCodes. |
getLicenseCodesList()
public abstract List<Long> getLicenseCodesList()Integer license codes indicating which licenses are attached to this disk.
repeated int64 license_codes = 45482664;
| Returns | |
|---|---|
| Type | Description |
List<Long> | A list containing the licenseCodes. |
getLicenses(int index)
public abstract String getLicenses(int index)A list of publicly visible licenses. Reserved for Google's use.
repeated string licenses = 337642578;
| Parameter | |
|---|---|
| Name | Description |
index | intThe 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 | intThe 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. |
getLocationHint()
public abstract String getLocationHint()An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API.
optional string location_hint = 350519505;
| Returns | |
|---|---|
| Type | Description |
String | The locationHint. |
getLocationHintBytes()
public abstract ByteString getLocationHintBytes()An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API.
optional string location_hint = 350519505;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for locationHint. |
getName()
public abstract String getName() Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public abstract ByteString getNameBytes() Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
getOptions()
public abstract String getOptions()Internal use only.
optional string options = 361137822;
| Returns | |
|---|---|
| Type | Description |
String | The options. |
getOptionsBytes()
public abstract ByteString getOptionsBytes()Internal use only.
optional string options = 361137822;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for options. |
getParams()
public abstract DiskParams getParams()Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
optional .google.cloud.compute.v1.DiskParams params = 78313862;
| Returns | |
|---|---|
| Type | Description |
DiskParams | The params. |
getParamsOrBuilder()
public abstract DiskParamsOrBuilder getParamsOrBuilder()Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
optional .google.cloud.compute.v1.DiskParams params = 78313862;
| Returns | |
|---|---|
| Type | Description |
DiskParamsOrBuilder | |
getPhysicalBlockSizeBytes()
public abstract long getPhysicalBlockSizeBytes()Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.
optional int64 physical_block_size_bytes = 420007943;
| Returns | |
|---|---|
| Type | Description |
long | The physicalBlockSizeBytes. |
getProvisionedIops()
public 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. |
getRegion()
public abstract String getRegion()[Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;
| Returns | |
|---|---|
| Type | Description |
String | The region. |
getRegionBytes()
public abstract ByteString getRegionBytes()[Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for region. |
getReplicaZones(int index)
public abstract String getReplicaZones(int index)URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
repeated string replica_zones = 48438272;
| Parameter | |
|---|---|
| Name | Description |
index | intThe 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)URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
repeated string replica_zones = 48438272;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the replicaZones at the given index. |
getReplicaZonesCount()
public abstract int getReplicaZonesCount()URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
repeated string replica_zones = 48438272;
| Returns | |
|---|---|
| Type | Description |
int | The count of replicaZones. |
getReplicaZonesList()
public abstract List<String> getReplicaZonesList()URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
repeated string replica_zones = 48438272;
| Returns | |
|---|---|
| Type | Description |
List<String> | A list containing the replicaZones. |
getResourcePolicies(int index)
public abstract String getResourcePolicies(int index)Resource policies applied to this disk for automatic snapshot creations.
repeated string resource_policies = 22220385;
| Parameter | |
|---|---|
| Name | Description |
index | intThe 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.
repeated string resource_policies = 22220385;
| Parameter | |
|---|---|
| Name | Description |
index | intThe 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.
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.
repeated string resource_policies = 22220385;
| Returns | |
|---|---|
| Type | Description |
List<String> | A list containing the resourcePolicies. |
getSatisfiesPzs()
public abstract boolean getSatisfiesPzs()[Output Only] Reserved for future use.
optional bool satisfies_pzs = 480964267;
| Returns | |
|---|---|
| Type | Description |
boolean | The satisfiesPzs. |
getSelfLink()
public abstract String getSelfLink()[Output Only] Server-defined fully-qualified URL for this resource.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
String | The selfLink. |
getSelfLinkBytes()
public abstract ByteString getSelfLinkBytes()[Output Only] Server-defined fully-qualified URL for this resource.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for selfLink. |
getSizeGb()
public abstract long getSizeGb()Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive.
optional int64 size_gb = 494929369;
| Returns | |
|---|---|
| Type | Description |
long | The sizeGb. |
getSourceDisk()
public abstract String getSourceDisk()The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
optional string source_disk = 451753793;
| Returns | |
|---|---|
| Type | Description |
String | The sourceDisk. |
getSourceDiskBytes()
public abstract ByteString getSourceDiskBytes()The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
optional string source_disk = 451753793;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for sourceDisk. |
getSourceDiskId()
public abstract String getSourceDiskId()[Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.
optional string source_disk_id = 454190809;
| Returns | |
|---|---|
| Type | Description |
String | The sourceDiskId. |
getSourceDiskIdBytes()
public abstract ByteString getSourceDiskIdBytes()[Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.
optional string source_disk_id = 454190809;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for sourceDiskId. |
getSourceImage()
public abstract String getSourceImage()The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family
optional string source_image = 50443319;
| Returns | |
|---|---|
| Type | Description |
String | The sourceImage. |
getSourceImageBytes()
public abstract ByteString getSourceImageBytes()The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family
optional string source_image = 50443319;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for sourceImage. |
getSourceImageEncryptionKey()
public 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.
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.
optional .google.cloud.compute.v1.CustomerEncryptionKey source_image_encryption_key = 381503659;
| Returns | |
|---|---|
| Type | Description |
CustomerEncryptionKeyOrBuilder | |
getSourceImageId()
public abstract String getSourceImageId()[Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
optional string source_image_id = 55328291;
| Returns | |
|---|---|
| Type | Description |
String | The sourceImageId. |
getSourceImageIdBytes()
public abstract ByteString getSourceImageIdBytes()[Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
optional string source_image_id = 55328291;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for sourceImageId. |
getSourceSnapshot()
public abstract String getSourceSnapshot()The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot
optional string source_snapshot = 126061928;
| Returns | |
|---|---|
| Type | Description |
String | The sourceSnapshot. |
getSourceSnapshotBytes()
public abstract ByteString getSourceSnapshotBytes()The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot
optional string source_snapshot = 126061928;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for sourceSnapshot. |
getSourceSnapshotEncryptionKey()
public abstract CustomerEncryptionKey getSourceSnapshotEncryptionKey()The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
optional .google.cloud.compute.v1.CustomerEncryptionKey source_snapshot_encryption_key = 303679322;
| Returns | |
|---|---|
| Type | Description |
CustomerEncryptionKey | The sourceSnapshotEncryptionKey. |
getSourceSnapshotEncryptionKeyOrBuilder()
public abstract CustomerEncryptionKeyOrBuilder getSourceSnapshotEncryptionKeyOrBuilder()The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
optional .google.cloud.compute.v1.CustomerEncryptionKey source_snapshot_encryption_key = 303679322;
| Returns | |
|---|---|
| Type | Description |
CustomerEncryptionKeyOrBuilder | |
getSourceSnapshotId()
public abstract String getSourceSnapshotId()[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
optional string source_snapshot_id = 98962258;
| Returns | |
|---|---|
| Type | Description |
String | The sourceSnapshotId. |
getSourceSnapshotIdBytes()
public abstract ByteString getSourceSnapshotIdBytes()[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
optional string source_snapshot_id = 98962258;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for sourceSnapshotId. |
getSourceStorageObject()
public abstract String getSourceStorageObject()The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.
optional string source_storage_object = 233052711;
| Returns | |
|---|---|
| Type | Description |
String | The sourceStorageObject. |
getSourceStorageObjectBytes()
public abstract ByteString getSourceStorageObjectBytes()The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.
optional string source_storage_object = 233052711;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for sourceStorageObject. |
getStatus()
public abstract String getStatus()[Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. Check the Status enum for the list of possible values.
optional string status = 181260274;
| Returns | |
|---|---|
| Type | Description |
String | The status. |
getStatusBytes()
public abstract ByteString getStatusBytes()[Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. Check the Status enum for the list of possible values.
optional string status = 181260274;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for status. |
getType()
public abstract String getType()URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types.
optional string type = 3575610;
| Returns | |
|---|---|
| Type | Description |
String | The type. |
getTypeBytes()
public abstract ByteString getTypeBytes()URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types.
optional string type = 3575610;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for type. |
getUsers(int index)
public abstract String getUsers(int index)[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance
repeated string users = 111578632;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The users at the given index. |
getUsersBytes(int index)
public abstract ByteString getUsersBytes(int index)[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance
repeated string users = 111578632;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the users at the given index. |
getUsersCount()
public abstract int getUsersCount()[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance
repeated string users = 111578632;
| Returns | |
|---|---|
| Type | Description |
int | The count of users. |
getUsersList()
public abstract List<String> getUsersList()[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance
repeated string users = 111578632;
| Returns | |
|---|---|
| Type | Description |
List<String> | A list containing the users. |
getZone()
public abstract String getZone()[Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string zone = 3744684;
| Returns | |
|---|---|
| Type | Description |
String | The zone. |
getZoneBytes()
public abstract ByteString getZoneBytes()[Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string zone = 3744684;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for zone. |
hasArchitecture()
public abstract boolean hasArchitecture()The architecture of the disk. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.
optional string architecture = 302803283;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the architecture field is set. |
hasCreationTimestamp()
public abstract boolean hasCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the creationTimestamp field is set. |
hasDescription()
public abstract boolean hasDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the description field is set. |
hasDiskEncryptionKey()
public abstract boolean hasDiskEncryptionKey()Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format: "diskEncryptionKey.kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later.
optional .google.cloud.compute.v1.CustomerEncryptionKey disk_encryption_key = 271660677;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the diskEncryptionKey field is set. |
hasId()
public abstract boolean hasId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the id field is set. |
hasKind()
public abstract boolean hasKind()[Output Only] Type of the resource. Always compute#disk for disks.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the kind field is set. |
hasLabelFingerprint()
public abstract boolean hasLabelFingerprint()A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.
optional string label_fingerprint = 178124825;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the labelFingerprint field is set. |
hasLastAttachTimestamp()
public abstract boolean hasLastAttachTimestamp()[Output Only] Last attach timestamp in RFC3339 text format.
optional string last_attach_timestamp = 42159653;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the lastAttachTimestamp field is set. |
hasLastDetachTimestamp()
public abstract boolean hasLastDetachTimestamp()[Output Only] Last detach timestamp in RFC3339 text format.
optional string last_detach_timestamp = 56471027;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the lastDetachTimestamp field is set. |
hasLocationHint()
public abstract boolean hasLocationHint()An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API.
optional string location_hint = 350519505;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the locationHint field is set. |
hasName()
public abstract boolean hasName() Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the name field is set. |
hasOptions()
public abstract boolean hasOptions()Internal use only.
optional string options = 361137822;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the options field is set. |
hasParams()
public abstract boolean hasParams()Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
optional .google.cloud.compute.v1.DiskParams params = 78313862;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the params field is set. |
hasPhysicalBlockSizeBytes()
public abstract boolean hasPhysicalBlockSizeBytes()Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.
optional int64 physical_block_size_bytes = 420007943;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the physicalBlockSizeBytes field is set. |
hasProvisionedIops()
public 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. |
hasRegion()
public abstract boolean hasRegion()[Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the region field is set. |
hasSatisfiesPzs()
public abstract boolean hasSatisfiesPzs()[Output Only] Reserved for future use.
optional bool satisfies_pzs = 480964267;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the satisfiesPzs field is set. |
hasSelfLink()
public abstract boolean hasSelfLink()[Output Only] Server-defined fully-qualified URL for this resource.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the selfLink field is set. |
hasSizeGb()
public abstract boolean hasSizeGb()Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive.
optional int64 size_gb = 494929369;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sizeGb field is set. |
hasSourceDisk()
public abstract boolean hasSourceDisk()The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
optional string source_disk = 451753793;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sourceDisk field is set. |
hasSourceDiskId()
public abstract boolean hasSourceDiskId()[Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.
optional string source_disk_id = 454190809;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sourceDiskId field is set. |
hasSourceImage()
public abstract boolean hasSourceImage()The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family
optional string source_image = 50443319;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sourceImage field is set. |
hasSourceImageEncryptionKey()
public 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.
optional .google.cloud.compute.v1.CustomerEncryptionKey source_image_encryption_key = 381503659;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sourceImageEncryptionKey field is set. |
hasSourceImageId()
public abstract boolean hasSourceImageId()[Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
optional string source_image_id = 55328291;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sourceImageId field is set. |
hasSourceSnapshot()
public abstract boolean hasSourceSnapshot()The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot
optional string source_snapshot = 126061928;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sourceSnapshot field is set. |
hasSourceSnapshotEncryptionKey()
public abstract boolean hasSourceSnapshotEncryptionKey()The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
optional .google.cloud.compute.v1.CustomerEncryptionKey source_snapshot_encryption_key = 303679322;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sourceSnapshotEncryptionKey field is set. |
hasSourceSnapshotId()
public abstract boolean hasSourceSnapshotId()[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
optional string source_snapshot_id = 98962258;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sourceSnapshotId field is set. |
hasSourceStorageObject()
public abstract boolean hasSourceStorageObject()The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.
optional string source_storage_object = 233052711;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sourceStorageObject field is set. |
hasStatus()
public abstract boolean hasStatus()[Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. Check the Status enum for the list of possible values.
optional string status = 181260274;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the status field is set. |
hasType()
public abstract boolean hasType()URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types.
optional string type = 3575610;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the type field is set. |
hasZone()
public abstract boolean hasZone()[Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string zone = 3744684;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the zone field is set. |