Disk (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.Disk

All Implemented Interfaces:: com.google.api.gax.httpjson.ApiMessage

@Generated(value="by GAPIC")
 @BetaApi
public final class Disk
extends Object
implements com.google.api.gax.httpjson.ApiMessage

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Disk.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`Disk.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`com.google.api.gax.httpjson.ApiMessage`	`getApiMessageRequestBody()`
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`static Disk`	`getDefaultInstance()`
`String`	`getDescription()` An optional description of this resource.
`CustomerEncryptionKey`	`getDiskEncryptionKey()` Encrypts the disk using a customer-supplied encryption key.
`List<String>`	`getFieldMask()`
`Object`	`getFieldValue(String fieldName)`
`List<GuestOsFeature>`	`getGuestOsFeaturesList()` A list of features to enable on the guest operating system.
`String`	`getId()` [Output Only] The unique identifier for the resource.
`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>`	`getLabelsMap()` 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<String>`	`getLicenseCodesList()` Integer license codes indicating which licenses are attached to this disk.
`List<String>`	`getLicensesList()` A list of publicly visible licenses.
`String`	`getName()` Name of the resource.
`String`	`getOptions()` Internal use only.
`String`	`getPhysicalBlockSizeBytes()` Physical block size of the persistent disk, in bytes.
`String`	`getRegion()` [Output Only] URL of the region where the disk resides.
`List<String>`	`getReplicaZonesList()` URLs of the zones where the disk should be replicated to.
`List<String>`	`getResourcePoliciesList()` Resource policies applied to this disk for automatic snapshot creations.
`String`	`getSelfLink()` [Output Only] Server-defined fully-qualified URL for this resource.
`String`	`getSizeGb()` Size of the persistent disk, specified in GB.
`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`	`getStatus()` [Output Only] The status of disk creation.
`String`	`getType()` URL of the disk type resource describing which disk type to use to create the disk.
`List<String>`	`getUsersList()` [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.
`int`	`hashCode()`
`static Disk.Builder`	`newBuilder()`
`static Disk.Builder`	`newBuilder(Disk prototype)`
`Disk.Builder`	`toBuilder()`
`String`	`toString()`

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

- Method Detail
  - getFieldValue
```
public Object getFieldValue(String fieldName)
```
    Specified by:
    
    getFieldValue in interface com.google.api.gax.httpjson.ApiMessage
  - getApiMessageRequestBody
```
@Nullable
public com.google.api.gax.httpjson.ApiMessage getApiMessageRequestBody()
```
    Specified by:
    
    getApiMessageRequestBody in interface com.google.api.gax.httpjson.ApiMessage
  - getFieldMask
```
@Nullable
public List<String> getFieldMask()
```
    Specified by:
    
    getFieldMask in interface com.google.api.gax.httpjson.ApiMessage
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
  - getDiskEncryptionKey
```
public CustomerEncryptionKey getDiskEncryptionKey()
```
    Encrypts the disk using a customer-supplied encryption key.
    After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine).
    Customer-supplied encryption keys do not protect access to metadata of the disk.
    If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.
  - 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.
  - getId
```
public String getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  - getKind
```
public String getKind()
```
    [Output Only] Type of the resource. Always compute#disk for disks.
  - 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.
  - getLabelsMap
```
public Map<String,String> getLabelsMap()
```
    Labels to apply to this disk. These can be later modified by the setLabels method.
  - getLastAttachTimestamp
```
public String getLastAttachTimestamp()
```
    [Output Only] Last attach timestamp in RFC3339 text format.
  - getLastDetachTimestamp
```
public String getLastDetachTimestamp()
```
    [Output Only] Last detach timestamp in RFC3339 text format.
  - getLicenseCodesList
```
public List<String> getLicenseCodesList()
```
    Integer license codes indicating which licenses are attached to this disk.
  - getLicensesList
```
public List<String> getLicensesList()
```
    A list of publicly visible licenses. Reserved for Google's use.
  - 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.
  - getOptions
```
public String getOptions()
```
    Internal use only.
  - getPhysicalBlockSizeBytes
```
public String getPhysicalBlockSizeBytes()
```
    Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, 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.
  - 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.
  - getReplicaZonesList
```
public List<String> getReplicaZonesList()
```
    URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
  - getResourcePoliciesList
```
public List<String> getResourcePoliciesList()
```
    Resource policies applied to this disk for automatic snapshot creations.
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined fully-qualified URL for this resource.
  - getSizeGb
```
public String getSizeGb()
```
    Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
    If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive.
  - 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
  - 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.
  - 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.
  - 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
  - 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.
  - 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.
  - 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.
  - 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-standard or pd-ssd
  - getUsersList
```
public List<String> getUsersList()
```
    [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance
  - 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.
  - newBuilder
```
public static Disk.Builder newBuilder()
```
  - newBuilder
```
public static Disk.Builder newBuilder(Disk prototype)
```
  - toBuilder
```
public Disk.Builder toBuilder()
```
  - getDefaultInstance
```
public static Disk getDefaultInstance()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Disk

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getFieldValue

getApiMessageRequestBody

getFieldMask

getCreationTimestamp

getDescription

getDiskEncryptionKey

getGuestOsFeaturesList

getId

getKind

getLabelFingerprint

getLabelsMap

getLastAttachTimestamp

getLastDetachTimestamp

getLicenseCodesList

getLicensesList

getName

getOptions

getPhysicalBlockSizeBytes

getRegion

getReplicaZonesList

getResourcePoliciesList

getSelfLink

getSizeGb

getSourceImage

getSourceImageEncryptionKey

getSourceImageId

getSourceSnapshot

getSourceSnapshotEncryptionKey

getSourceSnapshotId

getStatus

getType

getUsersList

getZone

newBuilder

newBuilder

toBuilder

getDefaultInstance

toString

equals

hashCode