Disk (Compute Engine API beta-rev20220726-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.Disk

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Disk
extends GenericJson
```
Represents a Persistent Disk resource. Google Compute Engine has two Disk resources: * [Zonal](/compute/docs/reference/rest/beta/disks) * [Regional](/compute/docs/reference/rest/beta/regionDisks) 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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Disk()

Constructors
Constructor and Description
`Disk()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Disk`	`clone()`
`byte[]`	`decodeLabelFingerprint()` A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking.
`Disk`	`encodeLabelFingerprint(byte[] labelFingerprint)` A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking.
`String`	`getArchitecture()` The architecture of the disk.
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`String`	`getDescription()` An optional description of this resource.
`CustomerEncryptionKey`	`getDiskEncryptionKey()` Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key.
`Boolean`	`getEraseWindowsVssSignature()` Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature.
`List<GuestOsFeature>`	`getGuestOsFeatures()` A list of features to enable on the guest operating system.
`BigInteger`	`getId()` [Output Only] The unique identifier for the resource.
`String`	`getInterface()` [Deprecated] Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.
`String`	`getKind()` [Output Only] Type of the resource.
`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.
`Map<String,String>`	`getLabels()` Labels to apply to this disk.
`String`	`getLastAttachTimestamp()` [Output Only] Last attach timestamp in RFC3339 text format.
`String`	`getLastDetachTimestamp()` [Output Only] Last detach timestamp in RFC3339 text format.
`List<Long>`	`getLicenseCodes()` Integer license codes indicating which licenses are attached to this disk.
`List<String>`	`getLicenses()` A list of publicly visible licenses.
`String`	`getLocationHint()` An opaque location hint used to place the disk close to other resources.
`Boolean`	`getLocked()` [Output Only] The field indicates if the disk is created from a locked source image.
`Boolean`	`getMultiWriter()` Indicates whether or not the disk can be read/write attached to more than one instance.
`String`	`getName()` Name of the resource.
`String`	`getOptions()` Internal use only.
`DiskParams`	`getParams()` Input only.
`Long`	`getPhysicalBlockSizeBytes()` Physical block size of the persistent disk, in bytes.
`Long`	`getProvisionedIops()` Indicates how many IOPS to provision for the disk.
`String`	`getRegion()` [Output Only] URL of the region where the disk resides.
`List<String>`	`getReplicaZones()` URLs of the zones where the disk should be replicated to.
`List<String>`	`getResourcePolicies()` Resource policies applied to this disk for automatic snapshot creations.
`Boolean`	`getSatisfiesPzs()` [Output Only] Reserved for future use.
`String`	`getSelfLink()` [Output Only] Server-defined fully-qualified URL for this resource.
`Long`	`getSizeGb()` Size, in GB, of the persistent disk.
`String`	`getSourceDisk()` The source disk used to create this disk.
`String`	`getSourceDiskId()` [Output Only] The unique ID of the disk used to create this disk.
`String`	`getSourceImage()` The source image used to create this disk.
`CustomerEncryptionKey`	`getSourceImageEncryptionKey()` The customer-supplied encryption key of the source image.
`String`	`getSourceImageId()` [Output Only] The ID value of the image used to create this disk.
`String`	`getSourceSnapshot()` The source snapshot used to create this disk.
`CustomerEncryptionKey`	`getSourceSnapshotEncryptionKey()` The customer-supplied encryption key of the source snapshot.
`String`	`getSourceSnapshotId()` [Output Only] The unique ID of the snapshot used to create this disk.
`String`	`getSourceStorageObject()` The full Google Cloud Storage URI where the disk image is stored.
`String`	`getStatus()` [Output Only] The status of disk creation.
`String`	`getStorageType()` [Deprecated] Storage type of the persistent disk.
`String`	`getType()` URL of the disk type resource describing which disk type to use to create the disk.
`List<String>`	`getUserLicenses()` A list of publicly visible user-licenses.
`List<String>`	`getUsers()` [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance
`String`	`getZone()` [Output Only] URL of the zone where the disk resides.
`Disk`	`set(String fieldName, Object value)`
`Disk`	`setArchitecture(String architecture)` The architecture of the disk.
`Disk`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`Disk`	`setDescription(String description)` An optional description of this resource.
`Disk`	`setDiskEncryptionKey(CustomerEncryptionKey diskEncryptionKey)` Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key.
`Disk`	`setEraseWindowsVssSignature(Boolean eraseWindowsVssSignature)` Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature.
`Disk`	`setGuestOsFeatures(List<GuestOsFeature> guestOsFeatures)` A list of features to enable on the guest operating system.
`Disk`	`setId(BigInteger id)` [Output Only] The unique identifier for the resource.
`Disk`	`setInterface(String interface__)` [Deprecated] Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.
`Disk`	`setKind(String kind)` [Output Only] Type of the resource.
`Disk`	`setLabelFingerprint(String labelFingerprint)` A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking.
`Disk`	`setLabels(Map<String,String> labels)` Labels to apply to this disk.
`Disk`	`setLastAttachTimestamp(String lastAttachTimestamp)` [Output Only] Last attach timestamp in RFC3339 text format.
`Disk`	`setLastDetachTimestamp(String lastDetachTimestamp)` [Output Only] Last detach timestamp in RFC3339 text format.
`Disk`	`setLicenseCodes(List<Long> licenseCodes)` Integer license codes indicating which licenses are attached to this disk.
`Disk`	`setLicenses(List<String> licenses)` A list of publicly visible licenses.
`Disk`	`setLocationHint(String locationHint)` An opaque location hint used to place the disk close to other resources.
`Disk`	`setLocked(Boolean locked)` [Output Only] The field indicates if the disk is created from a locked source image.
`Disk`	`setMultiWriter(Boolean multiWriter)` Indicates whether or not the disk can be read/write attached to more than one instance.
`Disk`	`setName(String name)` Name of the resource.
`Disk`	`setOptions(String options)` Internal use only.
`Disk`	`setParams(DiskParams params)` Input only.
`Disk`	`setPhysicalBlockSizeBytes(Long physicalBlockSizeBytes)` Physical block size of the persistent disk, in bytes.
`Disk`	`setProvisionedIops(Long provisionedIops)` Indicates how many IOPS to provision for the disk.
`Disk`	`setRegion(String region)` [Output Only] URL of the region where the disk resides.
`Disk`	`setReplicaZones(List<String> replicaZones)` URLs of the zones where the disk should be replicated to.
`Disk`	`setResourcePolicies(List<String> resourcePolicies)` Resource policies applied to this disk for automatic snapshot creations.
`Disk`	`setSatisfiesPzs(Boolean satisfiesPzs)` [Output Only] Reserved for future use.
`Disk`	`setSelfLink(String selfLink)` [Output Only] Server-defined fully-qualified URL for this resource.
`Disk`	`setSizeGb(Long sizeGb)` Size, in GB, of the persistent disk.
`Disk`	`setSourceDisk(String sourceDisk)` The source disk used to create this disk.
`Disk`	`setSourceDiskId(String sourceDiskId)` [Output Only] The unique ID of the disk used to create this disk.
`Disk`	`setSourceImage(String sourceImage)` The source image used to create this disk.
`Disk`	`setSourceImageEncryptionKey(CustomerEncryptionKey sourceImageEncryptionKey)` The customer-supplied encryption key of the source image.
`Disk`	`setSourceImageId(String sourceImageId)` [Output Only] The ID value of the image used to create this disk.
`Disk`	`setSourceSnapshot(String sourceSnapshot)` The source snapshot used to create this disk.
`Disk`	`setSourceSnapshotEncryptionKey(CustomerEncryptionKey sourceSnapshotEncryptionKey)` The customer-supplied encryption key of the source snapshot.
`Disk`	`setSourceSnapshotId(String sourceSnapshotId)` [Output Only] The unique ID of the snapshot used to create this disk.
`Disk`	`setSourceStorageObject(String sourceStorageObject)` The full Google Cloud Storage URI where the disk image is stored.
`Disk`	`setStatus(String status)` [Output Only] The status of disk creation.
`Disk`	`setStorageType(String storageType)` [Deprecated] Storage type of the persistent disk.
`Disk`	`setType(String type)` URL of the disk type resource describing which disk type to use to create the disk.
`Disk`	`setUserLicenses(List<String> userLicenses)` A list of publicly visible user-licenses.
`Disk`	`setUsers(List<String> users)` [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance
`Disk`	`setZone(String zone)` [Output Only] URL of the zone where the disk resides.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Disk
```
public Disk()
```
- Method Detail
  - getArchitecture
```
public String getArchitecture()
```
    The architecture of the disk. Valid values are ARM64 or X86_64.
    
    Returns:
    
    value or null for none
  - setArchitecture
```
public Disk setArchitecture(String architecture)
```
    The architecture of the disk. Valid values are ARM64 or X86_64.
    
    Parameters:
    
    architecture - architecture or null for none
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setCreationTimestamp
```
public Disk setCreationTimestamp(String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Parameters:
    
    creationTimestamp - creationTimestamp or null for none
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Returns:
    
    value or null for none
  - setDescription
```
public Disk setDescription(String description)
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Parameters:
    
    description - description or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setDiskEncryptionKey
```
public Disk setDiskEncryptionKey(CustomerEncryptionKey diskEncryptionKey)
```
    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.
    
    Parameters:
    
    diskEncryptionKey - diskEncryptionKey or null for none
  - getEraseWindowsVssSignature
```
public Boolean getEraseWindowsVssSignature()
```
    Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature.
    
    Returns:
    
    value or null for none
  - setEraseWindowsVssSignature
```
public Disk setEraseWindowsVssSignature(Boolean eraseWindowsVssSignature)
```
    Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature.
    
    Parameters:
    
    eraseWindowsVssSignature - eraseWindowsVssSignature or null for none
  - getGuestOsFeatures
```
public List<GuestOsFeature> getGuestOsFeatures()
```
    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.
    
    Returns:
    
    value or null for none
  - setGuestOsFeatures
```
public Disk setGuestOsFeatures(List<GuestOsFeature> guestOsFeatures)
```
    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.
    
    Parameters:
    
    guestOsFeatures - guestOsFeatures or null for none
  - getId
```
public BigInteger getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Returns:
    
    value or null for none
  - setId
```
public Disk setId(BigInteger id)
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Parameters:
    
    id - id or null for none
  - getInterface
```
public String getInterface()
```
    [Deprecated] Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.
    
    Returns:
    
    value or null for none
  - setInterface
```
public Disk setInterface(String interface__)
```
    [Deprecated] Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI.
    
    Parameters:
    
    interface__ - interface__ or null for none
  - getKind
```
public String getKind()
```
    [Output Only] Type of the resource. Always compute#disk for disks.
    
    Returns:
    
    value or null for none
  - setKind
```
public Disk setKind(String kind)
```
    [Output Only] Type of the resource. Always compute#disk for disks.
    
    Parameters:
    
    kind - kind or null for none
  - 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.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeLabelFingerprint()
  - decodeLabelFingerprint
```
public byte[] decodeLabelFingerprint()
```
    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.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getLabelFingerprint()
  - setLabelFingerprint
```
public Disk setLabelFingerprint(String labelFingerprint)
```
    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.
    
    Parameters:
    
    labelFingerprint - labelFingerprint or null for none
    
    See Also:
    
    #encodeLabelFingerprint()
  - encodeLabelFingerprint
```
public Disk encodeLabelFingerprint(byte[] labelFingerprint)
```
    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.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getLabels
```
public Map<String,String> getLabels()
```
    Labels to apply to this disk. These can be later modified by the setLabels method.
    
    Returns:
    
    value or null for none
  - setLabels
```
public Disk setLabels(Map<String,String> labels)
```
    Labels to apply to this disk. These can be later modified by the setLabels method.
    
    Parameters:
    
    labels - labels or null for none
  - getLastAttachTimestamp
```
public String getLastAttachTimestamp()
```
    [Output Only] Last attach timestamp in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setLastAttachTimestamp
```
public Disk setLastAttachTimestamp(String lastAttachTimestamp)
```
    [Output Only] Last attach timestamp in RFC3339 text format.
    
    Parameters:
    
    lastAttachTimestamp - lastAttachTimestamp or null for none
  - getLastDetachTimestamp
```
public String getLastDetachTimestamp()
```
    [Output Only] Last detach timestamp in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setLastDetachTimestamp
```
public Disk setLastDetachTimestamp(String lastDetachTimestamp)
```
    [Output Only] Last detach timestamp in RFC3339 text format.
    
    Parameters:
    
    lastDetachTimestamp - lastDetachTimestamp or null for none
  - getLicenseCodes
```
public List<Long> getLicenseCodes()
```
    Integer license codes indicating which licenses are attached to this disk.
    
    Returns:
    
    value or null for none
  - setLicenseCodes
```
public Disk setLicenseCodes(List<Long> licenseCodes)
```
    Integer license codes indicating which licenses are attached to this disk.
    
    Parameters:
    
    licenseCodes - licenseCodes or null for none
  - getLicenses
```
public List<String> getLicenses()
```
    A list of publicly visible licenses. Reserved for Google's use.
    
    Returns:
    
    value or null for none
  - setLicenses
```
public Disk setLicenses(List<String> licenses)
```
    A list of publicly visible licenses. Reserved for Google's use.
    
    Parameters:
    
    licenses - licenses or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setLocationHint
```
public Disk setLocationHint(String locationHint)
```
    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.
    
    Parameters:
    
    locationHint - locationHint or null for none
  - getLocked
```
public Boolean getLocked()
```
    [Output Only] The field indicates if the disk is created from a locked source image. Attachment of a disk created from a locked source image will cause the following operations to become irreversibly prohibited: - R/W or R/O disk attachment to any other instance - Disk detachment. And the disk can only be deleted when the instance is deleted - Creation of images or snapshots - Disk cloning Furthermore, the instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Further attachment of secondary disks. - Detachment of any disks - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true for locked disks - Attach a locked disk with --auto-delete parameter set to false
    
    Returns:
    
    value or null for none
  - setLocked
```
public Disk setLocked(Boolean locked)
```
    [Output Only] The field indicates if the disk is created from a locked source image. Attachment of a disk created from a locked source image will cause the following operations to become irreversibly prohibited: - R/W or R/O disk attachment to any other instance - Disk detachment. And the disk can only be deleted when the instance is deleted - Creation of images or snapshots - Disk cloning Furthermore, the instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Further attachment of secondary disks. - Detachment of any disks - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true for locked disks - Attach a locked disk with --auto-delete parameter set to false
    
    Parameters:
    
    locked - locked or null for none
  - getMultiWriter
```
public Boolean getMultiWriter()
```
    Indicates whether or not the disk can be read/write attached to more than one instance.
    
    Returns:
    
    value or null for none
  - setMultiWriter
```
public Disk setMultiWriter(Boolean multiWriter)
```
    Indicates whether or not the disk can be read/write attached to more than one instance.
    
    Parameters:
    
    multiWriter - multiWriter or null for none
  - 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]([-a-z0-9]*[a-z0-9])?` 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.
    
    Returns:
    
    value or null for none
  - setName
```
public Disk setName(String name)
```
    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]([-a-z0-9]*[a-z0-9])?` 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.
    
    Parameters:
    
    name - name or null for none
  - getOptions
```
public String getOptions()
```
    Internal use only.
    
    Returns:
    
    value or null for none
  - setOptions
```
public Disk setOptions(String options)
```
    Internal use only.
    
    Parameters:
    
    options - options or null for none
  - getParams
```
public DiskParams getParams()
```
    Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
    
    Returns:
    
    value or null for none
  - setParams
```
public Disk setParams(DiskParams params)
```
    Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
    
    Parameters:
    
    params - params or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setPhysicalBlockSizeBytes
```
public Disk setPhysicalBlockSizeBytes(Long physicalBlockSizeBytes)
```
    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.
    
    Parameters:
    
    physicalBlockSizeBytes - physicalBlockSizeBytes or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setProvisionedIops
```
public Disk setProvisionedIops(Long provisionedIops)
```
    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.
    
    Parameters:
    
    provisionedIops - provisionedIops or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setRegion
```
public Disk setRegion(String region)
```
    [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.
    
    Parameters:
    
    region - region or null for none
  - getReplicaZones
```
public List<String> getReplicaZones()
```
    URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
    
    Returns:
    
    value or null for none
  - setReplicaZones
```
public Disk setReplicaZones(List<String> replicaZones)
```
    URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
    
    Parameters:
    
    replicaZones - replicaZones or null for none
  - getResourcePolicies
```
public List<String> getResourcePolicies()
```
    Resource policies applied to this disk for automatic snapshot creations.
    
    Returns:
    
    value or null for none
  - setResourcePolicies
```
public Disk setResourcePolicies(List<String> resourcePolicies)
```
    Resource policies applied to this disk for automatic snapshot creations.
    
    Parameters:
    
    resourcePolicies - resourcePolicies or null for none
  - getSatisfiesPzs
```
public Boolean getSatisfiesPzs()
```
    [Output Only] Reserved for future use.
    
    Returns:
    
    value or null for none
  - setSatisfiesPzs
```
public Disk setSatisfiesPzs(Boolean satisfiesPzs)
```
    [Output Only] Reserved for future use.
    
    Parameters:
    
    satisfiesPzs - satisfiesPzs or null for none
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined fully-qualified URL for this resource.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public Disk setSelfLink(String selfLink)
```
    [Output Only] Server-defined fully-qualified URL for this resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - 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 1 to 65536, inclusive.
    
    Returns:
    
    value or null for none
  - setSizeGb
```
public Disk setSizeGb(Long sizeGb)
```
    Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive.
    
    Parameters:
    
    sizeGb - sizeGb or null for none
  - 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
    
    Returns:
    
    value or null for none
  - setSourceDisk
```
public Disk setSourceDisk(String sourceDisk)
```
    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
    
    Parameters:
    
    sourceDisk - sourceDisk or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setSourceDiskId
```
public Disk setSourceDiskId(String sourceDiskId)
```
    [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.
    
    Parameters:
    
    sourceDiskId - sourceDiskId or null for none
  - 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
    
    Returns:
    
    value or null for none
  - setSourceImage
```
public Disk setSourceImage(String sourceImage)
```
    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
    
    Parameters:
    
    sourceImage - sourceImage or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setSourceImageEncryptionKey
```
public Disk setSourceImageEncryptionKey(CustomerEncryptionKey sourceImageEncryptionKey)
```
    The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
    
    Parameters:
    
    sourceImageEncryptionKey - sourceImageEncryptionKey or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setSourceImageId
```
public Disk setSourceImageId(String sourceImageId)
```
    [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.
    
    Parameters:
    
    sourceImageId - sourceImageId or null for none
  - 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
    
    Returns:
    
    value or null for none
  - setSourceSnapshot
```
public Disk setSourceSnapshot(String sourceSnapshot)
```
    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
    
    Parameters:
    
    sourceSnapshot - sourceSnapshot or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setSourceSnapshotEncryptionKey
```
public Disk setSourceSnapshotEncryptionKey(CustomerEncryptionKey sourceSnapshotEncryptionKey)
```
    The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
    
    Parameters:
    
    sourceSnapshotEncryptionKey - sourceSnapshotEncryptionKey or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setSourceSnapshotId
```
public Disk setSourceSnapshotId(String sourceSnapshotId)
```
    [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.
    
    Parameters:
    
    sourceSnapshotId - sourceSnapshotId or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setSourceStorageObject
```
public Disk setSourceStorageObject(String sourceStorageObject)
```
    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.
    
    Parameters:
    
    sourceStorageObject - sourceStorageObject or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setStatus
```
public Disk setStatus(String status)
```
    [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.
    
    Parameters:
    
    status - status or null for none
  - getStorageType
```
public String getStorageType()
```
    [Deprecated] Storage type of the persistent disk.
    
    Returns:
    
    value or null for none
  - setStorageType
```
public Disk setStorageType(String storageType)
```
    [Deprecated] Storage type of the persistent disk.
    
    Parameters:
    
    storageType - storageType or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setType
```
public Disk setType(String type)
```
    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.
    
    Parameters:
    
    type - type or null for none
  - getUserLicenses
```
public List<String> getUserLicenses()
```
    A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects /debian-cloud/global/licenses/debian-9-stretch
    
    Returns:
    
    value or null for none
  - setUserLicenses
```
public Disk setUserLicenses(List<String> userLicenses)
```
    A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects /debian-cloud/global/licenses/debian-9-stretch
    
    Parameters:
    
    userLicenses - userLicenses or null for none
  - getUsers
```
public List<String> getUsers()
```
    [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance
    
    Returns:
    
    value or null for none
  - setUsers
```
public Disk setUsers(List<String> users)
```
    [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance
    
    Parameters:
    
    users - users or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setZone
```
public Disk setZone(String zone)
```
    [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.
    
    Parameters:
    
    zone - zone or null for none
  - set
```
public Disk set(String fieldName,
                Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public Disk clone()
```
    Overrides:
    
    clone in class GenericJson

Class Disk

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Disk

Method Detail

getArchitecture

setArchitecture

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getDiskEncryptionKey

setDiskEncryptionKey

getEraseWindowsVssSignature

setEraseWindowsVssSignature

getGuestOsFeatures

setGuestOsFeatures

getId

setId

getInterface

setInterface

getKind

setKind

getLabelFingerprint

decodeLabelFingerprint

setLabelFingerprint

encodeLabelFingerprint

getLabels

setLabels

getLastAttachTimestamp

setLastAttachTimestamp

getLastDetachTimestamp

setLastDetachTimestamp

getLicenseCodes

setLicenseCodes

getLicenses

setLicenses

getLocationHint

setLocationHint

getLocked

setLocked

getMultiWriter

setMultiWriter

getName

setName

getOptions

setOptions

getParams

setParams

getPhysicalBlockSizeBytes

setPhysicalBlockSizeBytes

getProvisionedIops

setProvisionedIops

getRegion

setRegion

getReplicaZones

setReplicaZones

getResourcePolicies

setResourcePolicies

getSatisfiesPzs

setSatisfiesPzs

getSelfLink

setSelfLink

getSizeGb

setSizeGb

getSourceDisk

setSourceDisk

getSourceDiskId

setSourceDiskId

getSourceImage