Disk (Compute Engine API v1 (Rev. 103) 1.21.0)

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Disk
extends com.google.api.client.json.GenericJson
```
A Disk resource.
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
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Disk()

Constructors
Constructor and Description
`Disk()`

Method Summary

Methods
Modifier and Type	Method and Description
`Disk`	`clone()`
`java.lang.String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`java.lang.String`	`getDescription()` An optional description of this resource.
`java.math.BigInteger`	`getId()` [Output Only] The unique identifier for the resource.
`java.lang.String`	`getKind()` [Output Only] Type of the resource.
`java.lang.String`	`getLastAttachTimestamp()` [Output Only] Last attach timestamp in RFC3339 text format.
`java.lang.String`	`getLastDetachTimestamp()` [Output Only] Last detach timestamp in RFC3339 text format.
`java.util.List<java.lang.String>`	`getLicenses()` [Output Only] Any applicable publicly visible licenses.
`java.lang.String`	`getName()` Name of the resource.
`java.lang.String`	`getOptions()` Internal use only.
`java.lang.String`	`getSelfLink()` [Output Only] Server-defined fully-qualified URL for this resource.
`java.lang.Long`	`getSizeGb()` Size of the persistent disk, specified in GB.
`java.lang.String`	`getSourceImage()` The source image used to create this disk.
`java.lang.String`	`getSourceImageId()` [Output Only] The ID value of the image used to create this disk.
`java.lang.String`	`getSourceSnapshot()` The source snapshot used to create this disk.
`java.lang.String`	`getSourceSnapshotId()` [Output Only] The unique ID of the snapshot used to create this disk.
`java.lang.String`	`getStatus()` [Output Only] The status of disk creation.
`java.lang.String`	`getType()` URL of the disk type resource describing which disk type to use to create the disk.
`java.util.List<java.lang.String>`	`getUsers()` [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
`java.lang.String`	`getZone()` [Output Only] URL of the zone where the disk resides.
`Disk`	`set(java.lang.String fieldName, java.lang.Object value)`
`Disk`	`setCreationTimestamp(java.lang.String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`Disk`	`setDescription(java.lang.String description)` An optional description of this resource.
`Disk`	`setId(java.math.BigInteger id)` [Output Only] The unique identifier for the resource.
`Disk`	`setKind(java.lang.String kind)` [Output Only] Type of the resource.
`Disk`	`setLastAttachTimestamp(java.lang.String lastAttachTimestamp)` [Output Only] Last attach timestamp in RFC3339 text format.
`Disk`	`setLastDetachTimestamp(java.lang.String lastDetachTimestamp)` [Output Only] Last detach timestamp in RFC3339 text format.
`Disk`	`setLicenses(java.util.List<java.lang.String> licenses)` [Output Only] Any applicable publicly visible licenses.
`Disk`	`setName(java.lang.String name)` Name of the resource.
`Disk`	`setOptions(java.lang.String options)` Internal use only.
`Disk`	`setSelfLink(java.lang.String selfLink)` [Output Only] Server-defined fully-qualified URL for this resource.
`Disk`	`setSizeGb(java.lang.Long sizeGb)` Size of the persistent disk, specified in GB.
`Disk`	`setSourceImage(java.lang.String sourceImage)` The source image used to create this disk.
`Disk`	`setSourceImageId(java.lang.String sourceImageId)` [Output Only] The ID value of the image used to create this disk.
`Disk`	`setSourceSnapshot(java.lang.String sourceSnapshot)` The source snapshot used to create this disk.
`Disk`	`setSourceSnapshotId(java.lang.String sourceSnapshotId)` [Output Only] The unique ID of the snapshot used to create this disk.
`Disk`	`setStatus(java.lang.String status)` [Output Only] The status of disk creation.
`Disk`	`setType(java.lang.String type)` URL of the disk type resource describing which disk type to use to create the disk.
`Disk`	`setUsers(java.util.List<java.lang.String> users)` [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
`Disk`	`setZone(java.lang.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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

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

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

- Constructor Detail
  - Disk
```
public Disk()
```
- Method Detail
  - getCreationTimestamp
```
public java.lang.String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Returns:
    value or null for none
  - setCreationTimestamp
```
public Disk setCreationTimestamp(java.lang.String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Parameters:
    creationTimestamp - creationTimestamp or null for none
  - getDescription
```
public java.lang.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(java.lang.String description)
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Parameters:
    description - description or null for none
  - getId
```
public java.math.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(java.math.BigInteger id)
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Parameters:
    id - id or null for none
  - getKind
```
public java.lang.String getKind()
```
    [Output Only] Type of the resource. Always compute#disk for disks.
    
    Returns:
    value or null for none
  - setKind
```
public Disk setKind(java.lang.String kind)
```
    [Output Only] Type of the resource. Always compute#disk for disks.
    
    Parameters:
    kind - kind or null for none
  - getLastAttachTimestamp
```
public java.lang.String getLastAttachTimestamp()
```
    [Output Only] Last attach timestamp in RFC3339 text format.
    
    Returns:
    value or null for none
  - setLastAttachTimestamp
```
public Disk setLastAttachTimestamp(java.lang.String lastAttachTimestamp)
```
    [Output Only] Last attach timestamp in RFC3339 text format.
    
    Parameters:
    lastAttachTimestamp - lastAttachTimestamp or null for none
  - getLastDetachTimestamp
```
public java.lang.String getLastDetachTimestamp()
```
    [Output Only] Last detach timestamp in RFC3339 text format.
    
    Returns:
    value or null for none
  - setLastDetachTimestamp
```
public Disk setLastDetachTimestamp(java.lang.String lastDetachTimestamp)
```
    [Output Only] Last detach timestamp in RFC3339 text format.
    
    Parameters:
    lastDetachTimestamp - lastDetachTimestamp or null for none
  - getLicenses
```
public java.util.List<java.lang.String> getLicenses()
```
    [Output Only] Any applicable publicly visible licenses.
    
    Returns:
    value or null for none
  - setLicenses
```
public Disk setLicenses(java.util.List<java.lang.String> licenses)
```
    [Output Only] Any applicable publicly visible licenses.
    
    Parameters:
    licenses - licenses or null for none
  - getName
```
public java.lang.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(java.lang.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 java.lang.String getOptions()
```
    Internal use only.
    
    Returns:
    value or null for none
  - setOptions
```
public Disk setOptions(java.lang.String options)
```
    Internal use only.
    
    Parameters:
    options - options or null for none
  - getSelfLink
```
public java.lang.String getSelfLink()
```
    [Output Only] Server-defined fully-qualified URL for this resource.
    
    Returns:
    value or null for none
  - setSelfLink
```
public Disk setSelfLink(java.lang.String selfLink)
```
    [Output Only] Server-defined fully-qualified URL for this resource.
    
    Parameters:
    selfLink - selfLink or null for none
  - getSizeGb
```
public java.lang.Long 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.
    
    Returns:
    value or null for none
  - setSizeGb
```
public Disk setSizeGb(java.lang.Long sizeGb)
```
    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.
    
    Parameters:
    sizeGb - sizeGb or null for none
  - getSourceImage
```
public java.lang.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-8 to use the latest Debian 8 image: projects/debian-cloud/global/images/family/debian-8 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD To create a disk with a private image that you created, specify the image name in the following format: global/images/my-private-image You can also specify a private 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-private-family
    
    Returns:
    value or null for none
  - setSourceImage
```
public Disk setSourceImage(java.lang.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-8 to use the latest Debian 8 image: projects/debian-cloud/global/images/family/debian-8 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD To create a disk with a private image that you created, specify the image name in the following format: global/images/my-private-image You can also specify a private 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-private-family
    
    Parameters:
    sourceImage - sourceImage or null for none
  - getSourceImageId
```
public java.lang.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(java.lang.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 java.lang.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(java.lang.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
  - getSourceSnapshotId
```
public java.lang.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(java.lang.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
  - getStatus
```
public java.lang.String getStatus()
```
    [Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.
    
    Returns:
    value or null for none
  - setStatus
```
public Disk setStatus(java.lang.String status)
```
    [Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.
    
    Parameters:
    status - status or null for none
  - getType
```
public java.lang.String getType()
```
    URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
    
    Returns:
    value or null for none
  - setType
```
public Disk setType(java.lang.String type)
```
    URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
    
    Parameters:
    type - type or null for none
  - getUsers
```
public java.util.List<java.lang.String> getUsers()
```
    [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
    
    Returns:
    value or null for none
  - setUsers
```
public Disk setUsers(java.util.List<java.lang.String> users)
```
    [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
    
    Parameters:
    users - users or null for none
  - getZone
```
public java.lang.String getZone()
```
    [Output Only] URL of the zone where the disk resides.
    
    Returns:
    value or null for none
  - setZone
```
public Disk setZone(java.lang.String zone)
```
    [Output Only] URL of the zone where the disk resides.
    
    Parameters:
    zone - zone or null for none
  - set
```
public Disk set(java.lang.String fieldName,
       java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Disk clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Compute Engine API v1 (revision 103)

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

Constructor Detail

Disk

Method Detail

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getId

setId

getKind

setKind

getLastAttachTimestamp

setLastAttachTimestamp

getLastDetachTimestamp

setLastDetachTimestamp

getLicenses

setLicenses

getName

setName

getOptions

setOptions

getSelfLink

setSelfLink

getSizeGb

setSizeGb

getSourceImage

setSourceImage

getSourceImageId

setSourceImageId

getSourceSnapshot

setSourceSnapshot

getSourceSnapshotId

setSourceSnapshotId

getStatus

setStatus

getType

setType

getUsers

setUsers

getZone

setZone

set

clone