- 1.65.0 (latest)
- 1.64.0
- 1.63.0
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public static final class Disk.Builder extends GeneratedMessageV3.Builder<Disk.Builder> implements DiskOrBuilderRepresents a Persistent Disk resource. Google Compute Engine has two Disk resources: * Zonal * Regional Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources.
Protobuf type google.cloud.compute.v1.Disk
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Disk.BuilderImplements
DiskOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllGuestOsFeatures(Iterable<? extends GuestOsFeature> values)
public Disk.Builder addAllGuestOsFeatures(Iterable<? extends GuestOsFeature> values)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 |
values | Iterable<? extends com.google.cloud.compute.v1.GuestOsFeature> |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
addAllLicenseCodes(Iterable<? extends Long> values)
public Disk.Builder addAllLicenseCodes(Iterable<? extends Long> values)Integer license codes indicating which licenses are attached to this disk.
repeated int64 license_codes = 45482664;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends java.lang.Long>The licenseCodes to add. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
addAllLicenses(Iterable<String> values)
public Disk.Builder addAllLicenses(Iterable<String> values)A list of publicly visible licenses. Reserved for Google's use.
repeated string licenses = 337642578;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<String>The licenses to add. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
addAllReplicaZones(Iterable<String> values)
public Disk.Builder addAllReplicaZones(Iterable<String> values)URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
repeated string replica_zones = 48438272;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<String>The replicaZones to add. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
addAllResourcePolicies(Iterable<String> values)
public Disk.Builder addAllResourcePolicies(Iterable<String> values)Resource policies applied to this disk for automatic snapshot creations.
repeated string resource_policies = 22220385;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<String>The resourcePolicies to add. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
addAllUsers(Iterable<String> values)
public Disk.Builder addAllUsers(Iterable<String> values)[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 |
values | Iterable<String>The users to add. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
addGuestOsFeatures(GuestOsFeature value)
public Disk.Builder addGuestOsFeatures(GuestOsFeature value)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 |
value | GuestOsFeature |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
addGuestOsFeatures(GuestOsFeature.Builder builderForValue)
public Disk.Builder addGuestOsFeatures(GuestOsFeature.Builder builderForValue)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 |
builderForValue | GuestOsFeature.Builder |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
addGuestOsFeatures(int index, GuestOsFeature value)
public Disk.Builder addGuestOsFeatures(int index, GuestOsFeature value)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | GuestOsFeature |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
addGuestOsFeatures(int index, GuestOsFeature.Builder builderForValue)
public Disk.Builder addGuestOsFeatures(int index, GuestOsFeature.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | GuestOsFeature.Builder |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
addGuestOsFeaturesBuilder()
public GuestOsFeature.Builder addGuestOsFeaturesBuilder()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 |
GuestOsFeature.Builder | |
addGuestOsFeaturesBuilder(int index)
public GuestOsFeature.Builder addGuestOsFeaturesBuilder(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.Builder | |
addLicenseCodes(long value)
public Disk.Builder addLicenseCodes(long value)Integer license codes indicating which licenses are attached to this disk.
repeated int64 license_codes = 45482664;
| Parameter | |
|---|---|
| Name | Description |
value | longThe licenseCodes to add. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
addLicenses(String value)
public Disk.Builder addLicenses(String value)A list of publicly visible licenses. Reserved for Google's use.
repeated string licenses = 337642578;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe licenses to add. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
addLicensesBytes(ByteString value)
public Disk.Builder addLicensesBytes(ByteString value)A list of publicly visible licenses. Reserved for Google's use.
repeated string licenses = 337642578;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes of the licenses to add. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Disk.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
addReplicaZones(String value)
public Disk.Builder addReplicaZones(String value)URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
repeated string replica_zones = 48438272;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe replicaZones to add. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
addReplicaZonesBytes(ByteString value)
public Disk.Builder addReplicaZonesBytes(ByteString value)URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
repeated string replica_zones = 48438272;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes of the replicaZones to add. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
addResourcePolicies(String value)
public Disk.Builder addResourcePolicies(String value)Resource policies applied to this disk for automatic snapshot creations.
repeated string resource_policies = 22220385;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe resourcePolicies to add. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
addResourcePoliciesBytes(ByteString value)
public Disk.Builder addResourcePoliciesBytes(ByteString value)Resource policies applied to this disk for automatic snapshot creations.
repeated string resource_policies = 22220385;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes of the resourcePolicies to add. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
addUsers(String value)
public Disk.Builder addUsers(String value)[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 |
value | StringThe users to add. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
addUsersBytes(ByteString value)
public Disk.Builder addUsersBytes(ByteString value)[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 |
value | ByteStringThe bytes of the users to add. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
build()
public Disk build()| Returns | |
|---|---|
| Type | Description |
Disk | |
buildPartial()
public Disk buildPartial()| Returns | |
|---|---|
| Type | Description |
Disk | |
clear()
public Disk.Builder clear()| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
clearArchitecture()
public Disk.Builder clearArchitecture()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 |
Disk.Builder | This builder for chaining. |
clearAsyncPrimaryDisk()
public Disk.Builder clearAsyncPrimaryDisk()Disk asynchronously replicated into this disk.
optional .google.cloud.compute.v1.DiskAsyncReplication async_primary_disk = 180517533;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
clearAsyncSecondaryDisks()
public Disk.Builder clearAsyncSecondaryDisks()| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
clearCreationTimestamp()
public Disk.Builder clearCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearDescription()
public Disk.Builder clearDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearDiskEncryptionKey()
public Disk.Builder clearDiskEncryptionKey()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 |
Disk.Builder | |
clearEnableConfidentialCompute()
public Disk.Builder clearEnableConfidentialCompute()Whether this disk is using confidential compute mode.
optional bool enable_confidential_compute = 102135228;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Disk.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
clearGuestOsFeatures()
public Disk.Builder clearGuestOsFeatures()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 |
Disk.Builder | |
clearId()
public Disk.Builder clearId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearKind()
public Disk.Builder clearKind()[Output Only] Type of the resource. Always compute#disk for disks.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearLabelFingerprint()
public Disk.Builder clearLabelFingerprint()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 |
Disk.Builder | This builder for chaining. |
clearLabels()
public Disk.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
clearLastAttachTimestamp()
public Disk.Builder clearLastAttachTimestamp()[Output Only] Last attach timestamp in RFC3339 text format.
optional string last_attach_timestamp = 42159653;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearLastDetachTimestamp()
public Disk.Builder clearLastDetachTimestamp()[Output Only] Last detach timestamp in RFC3339 text format.
optional string last_detach_timestamp = 56471027;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearLicenseCodes()
public Disk.Builder clearLicenseCodes()Integer license codes indicating which licenses are attached to this disk.
repeated int64 license_codes = 45482664;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearLicenses()
public Disk.Builder clearLicenses()A list of publicly visible licenses. Reserved for Google's use.
repeated string licenses = 337642578;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearLocationHint()
public Disk.Builder clearLocationHint()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 |
Disk.Builder | This builder for chaining. |
clearName()
public Disk.Builder clearName() 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 |
Disk.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Disk.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
clearOptions()
public Disk.Builder clearOptions()Internal use only.
optional string options = 361137822;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearParams()
public Disk.Builder clearParams()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 |
Disk.Builder | |
clearPhysicalBlockSizeBytes()
public Disk.Builder clearPhysicalBlockSizeBytes()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 |
Disk.Builder | This builder for chaining. |
clearProvisionedIops()
public Disk.Builder clearProvisionedIops()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 |
Disk.Builder | This builder for chaining. |
clearProvisionedThroughput()
public Disk.Builder clearProvisionedThroughput()Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1.
optional int64 provisioned_throughput = 526524181;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearRegion()
public Disk.Builder clearRegion()[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 |
Disk.Builder | This builder for chaining. |
clearReplicaZones()
public Disk.Builder clearReplicaZones()URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
repeated string replica_zones = 48438272;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearResourcePolicies()
public Disk.Builder clearResourcePolicies()Resource policies applied to this disk for automatic snapshot creations.
repeated string resource_policies = 22220385;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearResourceStatus()
public Disk.Builder clearResourceStatus()[Output Only] Status information for the disk resource.
optional .google.cloud.compute.v1.DiskResourceStatus resource_status = 249429315;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
clearSatisfiesPzi()
public Disk.Builder clearSatisfiesPzi()Output only. Reserved for future use.
optional bool satisfies_pzi = 480964257;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearSatisfiesPzs()
public Disk.Builder clearSatisfiesPzs()[Output Only] Reserved for future use.
optional bool satisfies_pzs = 480964267;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearSelfLink()
public Disk.Builder clearSelfLink()[Output Only] Server-defined fully-qualified URL for this resource.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearSizeGb()
public Disk.Builder clearSizeGb()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 greater than 0.
optional int64 size_gb = 494929369;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearSourceConsistencyGroupPolicy()
public Disk.Builder clearSourceConsistencyGroupPolicy()[Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
optional string source_consistency_group_policy = 19616093;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearSourceConsistencyGroupPolicyId()
public Disk.Builder clearSourceConsistencyGroupPolicyId()[Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
optional string source_consistency_group_policy_id = 267568957;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearSourceDisk()
public Disk.Builder clearSourceDisk()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 |
Disk.Builder | This builder for chaining. |
clearSourceDiskId()
public Disk.Builder clearSourceDiskId()[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 |
Disk.Builder | This builder for chaining. |
clearSourceImage()
public Disk.Builder clearSourceImage()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 |
Disk.Builder | This builder for chaining. |
clearSourceImageEncryptionKey()
public Disk.Builder clearSourceImageEncryptionKey()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 |
Disk.Builder | |
clearSourceImageId()
public Disk.Builder clearSourceImageId()[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 |
Disk.Builder | This builder for chaining. |
clearSourceInstantSnapshot()
public Disk.Builder clearSourceInstantSnapshot()The source instant 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/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot
optional string source_instant_snapshot = 219202054;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearSourceInstantSnapshotId()
public Disk.Builder clearSourceInstantSnapshotId()[Output Only] The unique ID of the instant snapshot used to create this disk. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact version of the instant snapshot that was used.
optional string source_instant_snapshot_id = 287582708;
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
clearSourceSnapshot()
public Disk.Builder clearSourceSnapshot()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 |
Disk.Builder | This builder for chaining. |
clearSourceSnapshotEncryptionKey()
public Disk.Builder clearSourceSnapshotEncryptionKey()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 |
Disk.Builder | |
clearSourceSnapshotId()
public Disk.Builder clearSourceSnapshotId()[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 |
Disk.Builder | This builder for chaining. |
clearSourceStorageObject()
public Disk.Builder clearSourceStorageObject()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 |
Disk.Builder | This builder for chaining. |
clearStatus()
public Disk.Builder clearStatus()[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 |
Disk.Builder | This builder for chaining. |
clearType()
public Disk.Builder clearType()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 |
Disk.Builder | This builder for chaining. |
clearUsers()
public Disk.Builder clearUsers()[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 |
Disk.Builder | This builder for chaining. |
clearZone()
public Disk.Builder clearZone()[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 |
Disk.Builder | This builder for chaining. |
clone()
public Disk.Builder clone()| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
containsAsyncSecondaryDisks(String key)
public boolean containsAsyncSecondaryDisks(String key)[Output Only] A list of disks this disk is asynchronously replicated to.
map<string, .google.cloud.compute.v1.DiskAsyncReplicationList> async_secondary_disks = 322925608;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
containsLabels(String key)
public 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 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 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. |
getAsyncPrimaryDisk()
public DiskAsyncReplication getAsyncPrimaryDisk()Disk asynchronously replicated into this disk.
optional .google.cloud.compute.v1.DiskAsyncReplication async_primary_disk = 180517533;
| Returns | |
|---|---|
| Type | Description |
DiskAsyncReplication | The asyncPrimaryDisk. |
getAsyncPrimaryDiskBuilder()
public DiskAsyncReplication.Builder getAsyncPrimaryDiskBuilder()Disk asynchronously replicated into this disk.
optional .google.cloud.compute.v1.DiskAsyncReplication async_primary_disk = 180517533;
| Returns | |
|---|---|
| Type | Description |
DiskAsyncReplication.Builder | |
getAsyncPrimaryDiskOrBuilder()
public DiskAsyncReplicationOrBuilder getAsyncPrimaryDiskOrBuilder()Disk asynchronously replicated into this disk.
optional .google.cloud.compute.v1.DiskAsyncReplication async_primary_disk = 180517533;
| Returns | |
|---|---|
| Type | Description |
DiskAsyncReplicationOrBuilder | |
getAsyncSecondaryDisks() (deprecated)
public Map<String,DiskAsyncReplicationList> getAsyncSecondaryDisks()Use #getAsyncSecondaryDisksMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,DiskAsyncReplicationList> | |
getAsyncSecondaryDisksCount()
public int getAsyncSecondaryDisksCount()[Output Only] A list of disks this disk is asynchronously replicated to.
map<string, .google.cloud.compute.v1.DiskAsyncReplicationList> async_secondary_disks = 322925608;
| Returns | |
|---|---|
| Type | Description |
int | |
getAsyncSecondaryDisksMap()
public Map<String,DiskAsyncReplicationList> getAsyncSecondaryDisksMap()[Output Only] A list of disks this disk is asynchronously replicated to.
map<string, .google.cloud.compute.v1.DiskAsyncReplicationList> async_secondary_disks = 322925608;
| Returns | |
|---|---|
| Type | Description |
Map<String,DiskAsyncReplicationList> | |
getAsyncSecondaryDisksOrDefault(String key, DiskAsyncReplicationList defaultValue)
public DiskAsyncReplicationList getAsyncSecondaryDisksOrDefault(String key, DiskAsyncReplicationList defaultValue)[Output Only] A list of disks this disk is asynchronously replicated to.
map<string, .google.cloud.compute.v1.DiskAsyncReplicationList> async_secondary_disks = 322925608;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | DiskAsyncReplicationList |
| Returns | |
|---|---|
| Type | Description |
DiskAsyncReplicationList | |
getAsyncSecondaryDisksOrThrow(String key)
public DiskAsyncReplicationList getAsyncSecondaryDisksOrThrow(String key)[Output Only] A list of disks this disk is asynchronously replicated to.
map<string, .google.cloud.compute.v1.DiskAsyncReplicationList> async_secondary_disks = 322925608;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
DiskAsyncReplicationList | |
getCreationTimestamp()
public String getCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
String | The creationTimestamp. |
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for creationTimestamp. |
getDefaultInstanceForType()
public Disk getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Disk | |
getDescription()
public 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 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. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getDiskEncryptionKey()
public 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. |
getDiskEncryptionKeyBuilder()
public CustomerEncryptionKey.Builder getDiskEncryptionKeyBuilder()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.Builder | |
getDiskEncryptionKeyOrBuilder()
public 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 | |
getEnableConfidentialCompute()
public boolean getEnableConfidentialCompute()Whether this disk is using confidential compute mode.
optional bool enable_confidential_compute = 102135228;
| Returns | |
|---|---|
| Type | Description |
boolean | The enableConfidentialCompute. |
getGuestOsFeatures(int index)
public 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 | |
getGuestOsFeaturesBuilder(int index)
public GuestOsFeature.Builder getGuestOsFeaturesBuilder(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.Builder | |
getGuestOsFeaturesBuilderList()
public List<GuestOsFeature.Builder> getGuestOsFeaturesBuilderList()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<Builder> | |
getGuestOsFeaturesCount()
public 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 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 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 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 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 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 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 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 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() (deprecated)
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsCount()
public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 ProtocolStringList getLicensesList()A list of publicly visible licenses. Reserved for Google's use.
repeated string licenses = 337642578;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList | A list containing the licenses. |
getLocationHint()
public 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 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. |
getMutableAsyncSecondaryDisks() (deprecated)
public Map<String,DiskAsyncReplicationList> getMutableAsyncSecondaryDisks()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,DiskAsyncReplicationList> | |
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getName()
public 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 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 String getOptions()Internal use only.
optional string options = 361137822;
| Returns | |
|---|---|
| Type | Description |
String | The options. |
getOptionsBytes()
public ByteString getOptionsBytes()Internal use only.
optional string options = 361137822;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for options. |
getParams()
public 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. |
getParamsBuilder()
public DiskParams.Builder getParamsBuilder()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.Builder | |
getParamsOrBuilder()
public 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 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 long getProvisionedIops()Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.
optional int64 provisioned_iops = 186769108;
| Returns | |
|---|---|
| Type | Description |
long | The provisionedIops. |
getProvisionedThroughput()
public long getProvisionedThroughput()Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1.
optional int64 provisioned_throughput = 526524181;
| Returns | |
|---|---|
| Type | Description |
long | The provisionedThroughput. |
getRegion()
public 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 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 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 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 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 ProtocolStringList 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 |
ProtocolStringList | A list containing the replicaZones. |
getResourcePolicies(int index)
public 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 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 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 ProtocolStringList getResourcePoliciesList()Resource policies applied to this disk for automatic snapshot creations.
repeated string resource_policies = 22220385;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList | A list containing the resourcePolicies. |
getResourceStatus()
public DiskResourceStatus getResourceStatus()[Output Only] Status information for the disk resource.
optional .google.cloud.compute.v1.DiskResourceStatus resource_status = 249429315;
| Returns | |
|---|---|
| Type | Description |
DiskResourceStatus | The resourceStatus. |
getResourceStatusBuilder()
public DiskResourceStatus.Builder getResourceStatusBuilder()[Output Only] Status information for the disk resource.
optional .google.cloud.compute.v1.DiskResourceStatus resource_status = 249429315;
| Returns | |
|---|---|
| Type | Description |
DiskResourceStatus.Builder | |
getResourceStatusOrBuilder()
public DiskResourceStatusOrBuilder getResourceStatusOrBuilder()[Output Only] Status information for the disk resource.
optional .google.cloud.compute.v1.DiskResourceStatus resource_status = 249429315;
| Returns | |
|---|---|
| Type | Description |
DiskResourceStatusOrBuilder | |
getSatisfiesPzi()
public boolean getSatisfiesPzi()Output only. Reserved for future use.
optional bool satisfies_pzi = 480964257;
| Returns | |
|---|---|
| Type | Description |
boolean | The satisfiesPzi. |
getSatisfiesPzs()
public boolean getSatisfiesPzs()[Output Only] Reserved for future use.
optional bool satisfies_pzs = 480964267;
| Returns | |
|---|---|
| Type | Description |
boolean | The satisfiesPzs. |
getSelfLink()
public 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 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 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 greater than 0.
optional int64 size_gb = 494929369;
| Returns | |
|---|---|
| Type | Description |
long | The sizeGb. |
getSourceConsistencyGroupPolicy()
public String getSourceConsistencyGroupPolicy()[Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
optional string source_consistency_group_policy = 19616093;
| Returns | |
|---|---|
| Type | Description |
String | The sourceConsistencyGroupPolicy. |
getSourceConsistencyGroupPolicyBytes()
public ByteString getSourceConsistencyGroupPolicyBytes()[Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
optional string source_consistency_group_policy = 19616093;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for sourceConsistencyGroupPolicy. |
getSourceConsistencyGroupPolicyId()
public String getSourceConsistencyGroupPolicyId()[Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
optional string source_consistency_group_policy_id = 267568957;
| Returns | |
|---|---|
| Type | Description |
String | The sourceConsistencyGroupPolicyId. |
getSourceConsistencyGroupPolicyIdBytes()
public ByteString getSourceConsistencyGroupPolicyIdBytes()[Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
optional string source_consistency_group_policy_id = 267568957;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for sourceConsistencyGroupPolicyId. |
getSourceDisk()
public 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 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 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 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 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 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 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. |
getSourceImageEncryptionKeyBuilder()
public CustomerEncryptionKey.Builder getSourceImageEncryptionKeyBuilder()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.Builder | |
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.
optional .google.cloud.compute.v1.CustomerEncryptionKey source_image_encryption_key = 381503659;
| Returns | |
|---|---|
| Type | Description |
CustomerEncryptionKeyOrBuilder | |
getSourceImageId()
public 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 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. |
getSourceInstantSnapshot()
public String getSourceInstantSnapshot()The source instant 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/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot
optional string source_instant_snapshot = 219202054;
| Returns | |
|---|---|
| Type | Description |
String | The sourceInstantSnapshot. |
getSourceInstantSnapshotBytes()
public ByteString getSourceInstantSnapshotBytes()The source instant 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/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot
optional string source_instant_snapshot = 219202054;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for sourceInstantSnapshot. |
getSourceInstantSnapshotId()
public String getSourceInstantSnapshotId()[Output Only] The unique ID of the instant snapshot used to create this disk. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact version of the instant snapshot that was used.
optional string source_instant_snapshot_id = 287582708;
| Returns | |
|---|---|
| Type | Description |
String | The sourceInstantSnapshotId. |
getSourceInstantSnapshotIdBytes()
public ByteString getSourceInstantSnapshotIdBytes()[Output Only] The unique ID of the instant snapshot used to create this disk. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact version of the instant snapshot that was used.
optional string source_instant_snapshot_id = 287582708;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for sourceInstantSnapshotId. |
getSourceSnapshot()
public 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 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 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. |
getSourceSnapshotEncryptionKeyBuilder()
public CustomerEncryptionKey.Builder getSourceSnapshotEncryptionKeyBuilder()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.Builder | |
getSourceSnapshotEncryptionKeyOrBuilder()
public 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 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 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 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 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 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 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 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 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 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 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 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 ProtocolStringList 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 |
ProtocolStringList | A list containing the users. |
getZone()
public 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 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 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. |
hasAsyncPrimaryDisk()
public boolean hasAsyncPrimaryDisk()Disk asynchronously replicated into this disk.
optional .google.cloud.compute.v1.DiskAsyncReplication async_primary_disk = 180517533;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the asyncPrimaryDisk field is set. |
hasCreationTimestamp()
public 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 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 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. |
hasEnableConfidentialCompute()
public boolean hasEnableConfidentialCompute()Whether this disk is using confidential compute mode.
optional bool enable_confidential_compute = 102135228;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the enableConfidentialCompute field is set. |
hasId()
public 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 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 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 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 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 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 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 boolean hasOptions()Internal use only.
optional string options = 361137822;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the options field is set. |
hasParams()
public 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 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 boolean hasProvisionedIops()Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.
optional int64 provisioned_iops = 186769108;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the provisionedIops field is set. |
hasProvisionedThroughput()
public boolean hasProvisionedThroughput()Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1.
optional int64 provisioned_throughput = 526524181;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the provisionedThroughput field is set. |
hasRegion()
public 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. |
hasResourceStatus()
public boolean hasResourceStatus()[Output Only] Status information for the disk resource.
optional .google.cloud.compute.v1.DiskResourceStatus resource_status = 249429315;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the resourceStatus field is set. |
hasSatisfiesPzi()
public boolean hasSatisfiesPzi()Output only. Reserved for future use.
optional bool satisfies_pzi = 480964257;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the satisfiesPzi field is set. |
hasSatisfiesPzs()
public 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 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 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 greater than 0.
optional int64 size_gb = 494929369;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sizeGb field is set. |
hasSourceConsistencyGroupPolicy()
public boolean hasSourceConsistencyGroupPolicy()[Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
optional string source_consistency_group_policy = 19616093;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sourceConsistencyGroupPolicy field is set. |
hasSourceConsistencyGroupPolicyId()
public boolean hasSourceConsistencyGroupPolicyId()[Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
optional string source_consistency_group_policy_id = 267568957;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sourceConsistencyGroupPolicyId field is set. |
hasSourceDisk()
public 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 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 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 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 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. |
hasSourceInstantSnapshot()
public boolean hasSourceInstantSnapshot()The source instant 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/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot
optional string source_instant_snapshot = 219202054;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sourceInstantSnapshot field is set. |
hasSourceInstantSnapshotId()
public boolean hasSourceInstantSnapshotId()[Output Only] The unique ID of the instant snapshot used to create this disk. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact version of the instant snapshot that was used.
optional string source_instant_snapshot_id = 287582708;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sourceInstantSnapshotId field is set. |
hasSourceSnapshot()
public 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 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeAsyncPrimaryDisk(DiskAsyncReplication value)
public Disk.Builder mergeAsyncPrimaryDisk(DiskAsyncReplication value)Disk asynchronously replicated into this disk.
optional .google.cloud.compute.v1.DiskAsyncReplication async_primary_disk = 180517533;
| Parameter | |
|---|---|
| Name | Description |
value | DiskAsyncReplication |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
mergeDiskEncryptionKey(CustomerEncryptionKey value)
public Disk.Builder mergeDiskEncryptionKey(CustomerEncryptionKey value)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;
| Parameter | |
|---|---|
| Name | Description |
value | CustomerEncryptionKey |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
mergeFrom(Disk other)
public Disk.Builder mergeFrom(Disk other)| Parameter | |
|---|---|
| Name | Description |
other | Disk |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Disk.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Disk.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
mergeParams(DiskParams value)
public Disk.Builder mergeParams(DiskParams value)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;
| Parameter | |
|---|---|
| Name | Description |
value | DiskParams |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
mergeResourceStatus(DiskResourceStatus value)
public Disk.Builder mergeResourceStatus(DiskResourceStatus value)[Output Only] Status information for the disk resource.
optional .google.cloud.compute.v1.DiskResourceStatus resource_status = 249429315;
| Parameter | |
|---|---|
| Name | Description |
value | DiskResourceStatus |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
mergeSourceImageEncryptionKey(CustomerEncryptionKey value)
public Disk.Builder mergeSourceImageEncryptionKey(CustomerEncryptionKey value)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;
| Parameter | |
|---|---|
| Name | Description |
value | CustomerEncryptionKey |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
mergeSourceSnapshotEncryptionKey(CustomerEncryptionKey value)
public Disk.Builder mergeSourceSnapshotEncryptionKey(CustomerEncryptionKey value)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;
| Parameter | |
|---|---|
| Name | Description |
value | CustomerEncryptionKey |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Disk.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
putAllAsyncSecondaryDisks(Map<String,DiskAsyncReplicationList> values)
public Disk.Builder putAllAsyncSecondaryDisks(Map<String,DiskAsyncReplicationList> values)[Output Only] A list of disks this disk is asynchronously replicated to.
map<string, .google.cloud.compute.v1.DiskAsyncReplicationList> async_secondary_disks = 322925608;
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,DiskAsyncReplicationList> |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
putAllLabels(Map<String,String> values)
public Disk.Builder putAllLabels(Map<String,String> values)Labels to apply to this disk. These can be later modified by the setLabels method.
map<string, string> labels = 500195327;
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
putAsyncSecondaryDisks(String key, DiskAsyncReplicationList value)
public Disk.Builder putAsyncSecondaryDisks(String key, DiskAsyncReplicationList value)[Output Only] A list of disks this disk is asynchronously replicated to.
map<string, .google.cloud.compute.v1.DiskAsyncReplicationList> async_secondary_disks = 322925608;
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | DiskAsyncReplicationList |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
putAsyncSecondaryDisksBuilderIfAbsent(String key)
public DiskAsyncReplicationList.Builder putAsyncSecondaryDisksBuilderIfAbsent(String key)[Output Only] A list of disks this disk is asynchronously replicated to.
map<string, .google.cloud.compute.v1.DiskAsyncReplicationList> async_secondary_disks = 322925608;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
DiskAsyncReplicationList.Builder | |
putLabels(String key, String value)
public Disk.Builder putLabels(String key, String value)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 |
value | String |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
removeAsyncSecondaryDisks(String key)
public Disk.Builder removeAsyncSecondaryDisks(String key)[Output Only] A list of disks this disk is asynchronously replicated to.
map<string, .google.cloud.compute.v1.DiskAsyncReplicationList> async_secondary_disks = 322925608;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
removeGuestOsFeatures(int index)
public Disk.Builder removeGuestOsFeatures(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 |
Disk.Builder | |
removeLabels(String key)
public Disk.Builder removeLabels(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 |
Disk.Builder | |
setArchitecture(String value)
public Disk.Builder setArchitecture(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe architecture to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setArchitectureBytes(ByteString value)
public Disk.Builder setArchitectureBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for architecture to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setAsyncPrimaryDisk(DiskAsyncReplication value)
public Disk.Builder setAsyncPrimaryDisk(DiskAsyncReplication value)Disk asynchronously replicated into this disk.
optional .google.cloud.compute.v1.DiskAsyncReplication async_primary_disk = 180517533;
| Parameter | |
|---|---|
| Name | Description |
value | DiskAsyncReplication |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
setAsyncPrimaryDisk(DiskAsyncReplication.Builder builderForValue)
public Disk.Builder setAsyncPrimaryDisk(DiskAsyncReplication.Builder builderForValue)Disk asynchronously replicated into this disk.
optional .google.cloud.compute.v1.DiskAsyncReplication async_primary_disk = 180517533;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | DiskAsyncReplication.Builder |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
setCreationTimestamp(String value)
public Disk.Builder setCreationTimestamp(String value)[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe creationTimestamp to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setCreationTimestampBytes(ByteString value)
public Disk.Builder setCreationTimestampBytes(ByteString value)[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for creationTimestamp to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setDescription(String value)
public Disk.Builder setDescription(String value)An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setDescriptionBytes(ByteString value)
public Disk.Builder setDescriptionBytes(ByteString value)An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setDiskEncryptionKey(CustomerEncryptionKey value)
public Disk.Builder setDiskEncryptionKey(CustomerEncryptionKey value)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;
| Parameter | |
|---|---|
| Name | Description |
value | CustomerEncryptionKey |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
setDiskEncryptionKey(CustomerEncryptionKey.Builder builderForValue)
public Disk.Builder setDiskEncryptionKey(CustomerEncryptionKey.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | CustomerEncryptionKey.Builder |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
setEnableConfidentialCompute(boolean value)
public Disk.Builder setEnableConfidentialCompute(boolean value)Whether this disk is using confidential compute mode.
optional bool enable_confidential_compute = 102135228;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe enableConfidentialCompute to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Disk.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
setGuestOsFeatures(int index, GuestOsFeature value)
public Disk.Builder setGuestOsFeatures(int index, GuestOsFeature value)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | GuestOsFeature |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
setGuestOsFeatures(int index, GuestOsFeature.Builder builderForValue)
public Disk.Builder setGuestOsFeatures(int index, GuestOsFeature.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | GuestOsFeature.Builder |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
setId(long value)
public Disk.Builder setId(long value)[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Parameter | |
|---|---|
| Name | Description |
value | longThe id to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setKind(String value)
public Disk.Builder setKind(String value)[Output Only] Type of the resource. Always compute#disk for disks.
optional string kind = 3292052;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe kind to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setKindBytes(ByteString value)
public Disk.Builder setKindBytes(ByteString value)[Output Only] Type of the resource. Always compute#disk for disks.
optional string kind = 3292052;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for kind to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setLabelFingerprint(String value)
public Disk.Builder setLabelFingerprint(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe labelFingerprint to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setLabelFingerprintBytes(ByteString value)
public Disk.Builder setLabelFingerprintBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for labelFingerprint to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setLastAttachTimestamp(String value)
public Disk.Builder setLastAttachTimestamp(String value)[Output Only] Last attach timestamp in RFC3339 text format.
optional string last_attach_timestamp = 42159653;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe lastAttachTimestamp to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setLastAttachTimestampBytes(ByteString value)
public Disk.Builder setLastAttachTimestampBytes(ByteString value)[Output Only] Last attach timestamp in RFC3339 text format.
optional string last_attach_timestamp = 42159653;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for lastAttachTimestamp to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setLastDetachTimestamp(String value)
public Disk.Builder setLastDetachTimestamp(String value)[Output Only] Last detach timestamp in RFC3339 text format.
optional string last_detach_timestamp = 56471027;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe lastDetachTimestamp to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setLastDetachTimestampBytes(ByteString value)
public Disk.Builder setLastDetachTimestampBytes(ByteString value)[Output Only] Last detach timestamp in RFC3339 text format.
optional string last_detach_timestamp = 56471027;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for lastDetachTimestamp to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setLicenseCodes(int index, long value)
public Disk.Builder setLicenseCodes(int index, long value)Integer license codes indicating which licenses are attached to this disk.
repeated int64 license_codes = 45482664;
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | longThe licenseCodes to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setLicenses(int index, String value)
public Disk.Builder setLicenses(int index, String value)A list of publicly visible licenses. Reserved for Google's use.
repeated string licenses = 337642578;
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe licenses to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setLocationHint(String value)
public Disk.Builder setLocationHint(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe locationHint to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setLocationHintBytes(ByteString value)
public Disk.Builder setLocationHintBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for locationHint to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setName(String value)
public Disk.Builder setName(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public Disk.Builder setNameBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setOptions(String value)
public Disk.Builder setOptions(String value)Internal use only.
optional string options = 361137822;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe options to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setOptionsBytes(ByteString value)
public Disk.Builder setOptionsBytes(ByteString value)Internal use only.
optional string options = 361137822;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for options to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setParams(DiskParams value)
public Disk.Builder setParams(DiskParams value)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;
| Parameter | |
|---|---|
| Name | Description |
value | DiskParams |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
setParams(DiskParams.Builder builderForValue)
public Disk.Builder setParams(DiskParams.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | DiskParams.Builder |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
setPhysicalBlockSizeBytes(long value)
public Disk.Builder setPhysicalBlockSizeBytes(long value)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;
| Parameter | |
|---|---|
| Name | Description |
value | longThe physicalBlockSizeBytes to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setProvisionedIops(long value)
public Disk.Builder setProvisionedIops(long value)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;
| Parameter | |
|---|---|
| Name | Description |
value | longThe provisionedIops to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setProvisionedThroughput(long value)
public Disk.Builder setProvisionedThroughput(long value)Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1.
optional int64 provisioned_throughput = 526524181;
| Parameter | |
|---|---|
| Name | Description |
value | longThe provisionedThroughput to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setRegion(String value)
public Disk.Builder setRegion(String value)[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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe region to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setRegionBytes(ByteString value)
public Disk.Builder setRegionBytes(ByteString value)[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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for region to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Disk.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
setReplicaZones(int index, String value)
public Disk.Builder setReplicaZones(int index, String value)URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
repeated string replica_zones = 48438272;
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe replicaZones to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setResourcePolicies(int index, String value)
public Disk.Builder setResourcePolicies(int index, String value)Resource policies applied to this disk for automatic snapshot creations.
repeated string resource_policies = 22220385;
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe resourcePolicies to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setResourceStatus(DiskResourceStatus value)
public Disk.Builder setResourceStatus(DiskResourceStatus value)[Output Only] Status information for the disk resource.
optional .google.cloud.compute.v1.DiskResourceStatus resource_status = 249429315;
| Parameter | |
|---|---|
| Name | Description |
value | DiskResourceStatus |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
setResourceStatus(DiskResourceStatus.Builder builderForValue)
public Disk.Builder setResourceStatus(DiskResourceStatus.Builder builderForValue)[Output Only] Status information for the disk resource.
optional .google.cloud.compute.v1.DiskResourceStatus resource_status = 249429315;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | DiskResourceStatus.Builder |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
setSatisfiesPzi(boolean value)
public Disk.Builder setSatisfiesPzi(boolean value)Output only. Reserved for future use.
optional bool satisfies_pzi = 480964257;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe satisfiesPzi to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSatisfiesPzs(boolean value)
public Disk.Builder setSatisfiesPzs(boolean value)[Output Only] Reserved for future use.
optional bool satisfies_pzs = 480964267;
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe satisfiesPzs to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSelfLink(String value)
public Disk.Builder setSelfLink(String value)[Output Only] Server-defined fully-qualified URL for this resource.
optional string self_link = 456214797;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe selfLink to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSelfLinkBytes(ByteString value)
public Disk.Builder setSelfLinkBytes(ByteString value)[Output Only] Server-defined fully-qualified URL for this resource.
optional string self_link = 456214797;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for selfLink to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSizeGb(long value)
public Disk.Builder setSizeGb(long value)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 greater than 0.
optional int64 size_gb = 494929369;
| Parameter | |
|---|---|
| Name | Description |
value | longThe sizeGb to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceConsistencyGroupPolicy(String value)
public Disk.Builder setSourceConsistencyGroupPolicy(String value)[Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
optional string source_consistency_group_policy = 19616093;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe sourceConsistencyGroupPolicy to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceConsistencyGroupPolicyBytes(ByteString value)
public Disk.Builder setSourceConsistencyGroupPolicyBytes(ByteString value)[Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
optional string source_consistency_group_policy = 19616093;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for sourceConsistencyGroupPolicy to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceConsistencyGroupPolicyId(String value)
public Disk.Builder setSourceConsistencyGroupPolicyId(String value)[Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
optional string source_consistency_group_policy_id = 267568957;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe sourceConsistencyGroupPolicyId to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceConsistencyGroupPolicyIdBytes(ByteString value)
public Disk.Builder setSourceConsistencyGroupPolicyIdBytes(ByteString value)[Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
optional string source_consistency_group_policy_id = 267568957;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for sourceConsistencyGroupPolicyId to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceDisk(String value)
public Disk.Builder setSourceDisk(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe sourceDisk to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceDiskBytes(ByteString value)
public Disk.Builder setSourceDiskBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for sourceDisk to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceDiskId(String value)
public Disk.Builder setSourceDiskId(String value)[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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe sourceDiskId to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceDiskIdBytes(ByteString value)
public Disk.Builder setSourceDiskIdBytes(ByteString value)[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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for sourceDiskId to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceImage(String value)
public Disk.Builder setSourceImage(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe sourceImage to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceImageBytes(ByteString value)
public Disk.Builder setSourceImageBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for sourceImage to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceImageEncryptionKey(CustomerEncryptionKey value)
public Disk.Builder setSourceImageEncryptionKey(CustomerEncryptionKey value)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;
| Parameter | |
|---|---|
| Name | Description |
value | CustomerEncryptionKey |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
setSourceImageEncryptionKey(CustomerEncryptionKey.Builder builderForValue)
public Disk.Builder setSourceImageEncryptionKey(CustomerEncryptionKey.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | CustomerEncryptionKey.Builder |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
setSourceImageId(String value)
public Disk.Builder setSourceImageId(String value)[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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe sourceImageId to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceImageIdBytes(ByteString value)
public Disk.Builder setSourceImageIdBytes(ByteString value)[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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for sourceImageId to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceInstantSnapshot(String value)
public Disk.Builder setSourceInstantSnapshot(String value)The source instant 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/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot
optional string source_instant_snapshot = 219202054;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe sourceInstantSnapshot to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceInstantSnapshotBytes(ByteString value)
public Disk.Builder setSourceInstantSnapshotBytes(ByteString value)The source instant 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/zones/zone /instantSnapshots/instantSnapshot - projects/project/zones/zone/instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot
optional string source_instant_snapshot = 219202054;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for sourceInstantSnapshot to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceInstantSnapshotId(String value)
public Disk.Builder setSourceInstantSnapshotId(String value)[Output Only] The unique ID of the instant snapshot used to create this disk. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact version of the instant snapshot that was used.
optional string source_instant_snapshot_id = 287582708;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe sourceInstantSnapshotId to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceInstantSnapshotIdBytes(ByteString value)
public Disk.Builder setSourceInstantSnapshotIdBytes(ByteString value)[Output Only] The unique ID of the instant snapshot used to create this disk. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact version of the instant snapshot that was used.
optional string source_instant_snapshot_id = 287582708;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for sourceInstantSnapshotId to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceSnapshot(String value)
public Disk.Builder setSourceSnapshot(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe sourceSnapshot to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceSnapshotBytes(ByteString value)
public Disk.Builder setSourceSnapshotBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for sourceSnapshot to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceSnapshotEncryptionKey(CustomerEncryptionKey value)
public Disk.Builder setSourceSnapshotEncryptionKey(CustomerEncryptionKey value)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;
| Parameter | |
|---|---|
| Name | Description |
value | CustomerEncryptionKey |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
setSourceSnapshotEncryptionKey(CustomerEncryptionKey.Builder builderForValue)
public Disk.Builder setSourceSnapshotEncryptionKey(CustomerEncryptionKey.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | CustomerEncryptionKey.Builder |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
setSourceSnapshotId(String value)
public Disk.Builder setSourceSnapshotId(String value)[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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe sourceSnapshotId to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceSnapshotIdBytes(ByteString value)
public Disk.Builder setSourceSnapshotIdBytes(ByteString value)[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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for sourceSnapshotId to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceStorageObject(String value)
public Disk.Builder setSourceStorageObject(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe sourceStorageObject to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setSourceStorageObjectBytes(ByteString value)
public Disk.Builder setSourceStorageObjectBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for sourceStorageObject to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setStatus(String value)
public Disk.Builder setStatus(String value)[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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe status to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setStatusBytes(ByteString value)
public Disk.Builder setStatusBytes(ByteString value)[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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for status to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setType(String value)
public Disk.Builder setType(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe type to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setTypeBytes(ByteString value)
public Disk.Builder setTypeBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for type to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Disk.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | |
setUsers(int index, String value)
public Disk.Builder setUsers(int index, String value)[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance
repeated string users = 111578632;
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe users to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setZone(String value)
public Disk.Builder setZone(String value)[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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe zone to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |
setZoneBytes(ByteString value)
public Disk.Builder setZoneBytes(ByteString value)[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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for zone to set. |
| Returns | |
|---|---|
| Type | Description |
Disk.Builder | This builder for chaining. |