Snapshot (Compute Engine API v1 (Rev. 235) 1.25.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.Snapshot

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Snapshot
extends com.google.api.client.json.GenericJson
```
Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for {$api_version}.snapshots ==)
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

Snapshot()

Constructors
Constructor and Description
`Snapshot()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Snapshot`	`clone()`
`byte[]`	`decodeLabelFingerprint()` A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking.
`Snapshot`	`encodeLabelFingerprint(byte[] labelFingerprint)` A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking.
`java.lang.Boolean`	`getAutoCreated()` [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
`java.lang.String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`java.lang.String`	`getDescription()` An optional description of this resource.
`java.lang.Long`	`getDiskSizeGb()` [Output Only] Size of the source disk, specified in GB.
`java.lang.Long`	`getDownloadBytes()` [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
`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`	`getLabelFingerprint()` A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking.
`java.util.Map<java.lang.String,java.lang.String>`	`getLabels()` Labels to apply to this snapshot.
`java.util.List<java.lang.Long>`	`getLicenseCodes()` [Output Only] Integer license codes indicating which licenses are attached to this snapshot.
`java.util.List<java.lang.String>`	`getLicenses()` [Output Only] A list of public visible licenses that apply to this snapshot.
`java.lang.String`	`getName()` Name of the resource; provided by the client when the resource is created.
`java.lang.String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`CustomerEncryptionKey`	`getSnapshotEncryptionKey()` Encrypts the snapshot using a customer-supplied encryption key.
`java.lang.String`	`getSourceDisk()` [Output Only] The source disk used to create this snapshot.
`CustomerEncryptionKey`	`getSourceDiskEncryptionKey()` The customer-supplied encryption key of the source disk.
`java.lang.String`	`getSourceDiskId()` [Output Only] The ID value of the disk used to create this snapshot.
`java.lang.String`	`getStatus()` [Output Only] The status of the snapshot.
`java.lang.Long`	`getStorageBytes()` [Output Only] A size of the storage used by the snapshot.
`java.lang.String`	`getStorageBytesStatus()` [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation.
`java.util.List<java.lang.String>`	`getStorageLocations()` Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
`Snapshot`	`set(java.lang.String fieldName, java.lang.Object value)`
`Snapshot`	`setAutoCreated(java.lang.Boolean autoCreated)` [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
`Snapshot`	`setCreationTimestamp(java.lang.String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`Snapshot`	`setDescription(java.lang.String description)` An optional description of this resource.
`Snapshot`	`setDiskSizeGb(java.lang.Long diskSizeGb)` [Output Only] Size of the source disk, specified in GB.
`Snapshot`	`setDownloadBytes(java.lang.Long downloadBytes)` [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
`Snapshot`	`setId(java.math.BigInteger id)` [Output Only] The unique identifier for the resource.
`Snapshot`	`setKind(java.lang.String kind)` [Output Only] Type of the resource.
`Snapshot`	`setLabelFingerprint(java.lang.String labelFingerprint)` A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking.
`Snapshot`	`setLabels(java.util.Map<java.lang.String,java.lang.String> labels)` Labels to apply to this snapshot.
`Snapshot`	`setLicenseCodes(java.util.List<java.lang.Long> licenseCodes)` [Output Only] Integer license codes indicating which licenses are attached to this snapshot.
`Snapshot`	`setLicenses(java.util.List<java.lang.String> licenses)` [Output Only] A list of public visible licenses that apply to this snapshot.
`Snapshot`	`setName(java.lang.String name)` Name of the resource; provided by the client when the resource is created.
`Snapshot`	`setSelfLink(java.lang.String selfLink)` [Output Only] Server-defined URL for the resource.
`Snapshot`	`setSnapshotEncryptionKey(CustomerEncryptionKey snapshotEncryptionKey)` Encrypts the snapshot using a customer-supplied encryption key.
`Snapshot`	`setSourceDisk(java.lang.String sourceDisk)` [Output Only] The source disk used to create this snapshot.
`Snapshot`	`setSourceDiskEncryptionKey(CustomerEncryptionKey sourceDiskEncryptionKey)` The customer-supplied encryption key of the source disk.
`Snapshot`	`setSourceDiskId(java.lang.String sourceDiskId)` [Output Only] The ID value of the disk used to create this snapshot.
`Snapshot`	`setStatus(java.lang.String status)` [Output Only] The status of the snapshot.
`Snapshot`	`setStorageBytes(java.lang.Long storageBytes)` [Output Only] A size of the storage used by the snapshot.
`Snapshot`	`setStorageBytesStatus(java.lang.String storageBytesStatus)` [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation.
`Snapshot`	`setStorageLocations(java.util.List<java.lang.String> storageLocations)` Cloud Storage bucket storage location of the snapshot (regional or multi-regional).

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

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

- Constructor Detail
  - Snapshot
```
public Snapshot()
```
- Method Detail
  - getAutoCreated
```
public java.lang.Boolean getAutoCreated()
```
    [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
    
    Returns:
    
    value or null for none
  - setAutoCreated
```
public Snapshot setAutoCreated(java.lang.Boolean autoCreated)
```
    [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
    
    Parameters:
    
    autoCreated - autoCreated or null for none
  - getCreationTimestamp
```
public java.lang.String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setCreationTimestamp
```
public Snapshot 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 Snapshot 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
  - getDiskSizeGb
```
public java.lang.Long getDiskSizeGb()
```
    [Output Only] Size of the source disk, specified in GB.
    
    Returns:
    
    value or null for none
  - setDiskSizeGb
```
public Snapshot setDiskSizeGb(java.lang.Long diskSizeGb)
```
    [Output Only] Size of the source disk, specified in GB.
    
    Parameters:
    
    diskSizeGb - diskSizeGb or null for none
  - getDownloadBytes
```
public java.lang.Long getDownloadBytes()
```
    [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
    
    Returns:
    
    value or null for none
  - setDownloadBytes
```
public Snapshot setDownloadBytes(java.lang.Long downloadBytes)
```
    [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
    
    Parameters:
    
    downloadBytes - downloadBytes 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 Snapshot 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#snapshot for Snapshot resources.
    
    Returns:
    
    value or null for none
  - setKind
```
public Snapshot setKind(java.lang.String kind)
```
    [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
    
    Parameters:
    
    kind - kind or null for none
  - getLabelFingerprint
```
public java.lang.String getLabelFingerprint()
```
    A fingerprint for the labels being applied to this snapshot, 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 snapshot.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeLabelFingerprint()
  - decodeLabelFingerprint
```
public byte[] decodeLabelFingerprint()
```
    A fingerprint for the labels being applied to this snapshot, 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 snapshot.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getLabelFingerprint()
  - setLabelFingerprint
```
public Snapshot setLabelFingerprint(java.lang.String labelFingerprint)
```
    A fingerprint for the labels being applied to this snapshot, 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 snapshot.
    
    Parameters:
    
    labelFingerprint - labelFingerprint or null for none
    
    See Also:
    
    #encodeLabelFingerprint()
  - encodeLabelFingerprint
```
public Snapshot encodeLabelFingerprint(byte[] labelFingerprint)
```
    A fingerprint for the labels being applied to this snapshot, 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 snapshot.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getLabels
```
public java.util.Map<java.lang.String,java.lang.String> getLabels()
```
    Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.
    
    Returns:
    
    value or null for none
  - setLabels
```
public Snapshot setLabels(java.util.Map<java.lang.String,java.lang.String> labels)
```
    Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.
    
    Parameters:
    
    labels - labels or null for none
  - getLicenseCodes
```
public java.util.List<java.lang.Long> getLicenseCodes()
```
    [Output Only] Integer license codes indicating which licenses are attached to this snapshot.
    
    Returns:
    
    value or null for none
  - setLicenseCodes
```
public Snapshot setLicenseCodes(java.util.List<java.lang.Long> licenseCodes)
```
    [Output Only] Integer license codes indicating which licenses are attached to this snapshot.
    
    Parameters:
    
    licenseCodes - licenseCodes or null for none
  - getLicenses
```
public java.util.List<java.lang.String> getLicenses()
```
    [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
    
    Returns:
    
    value or null for none
  - setLicenses
```
public Snapshot setLicenses(java.util.List<java.lang.String> licenses)
```
    [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
    
    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 Snapshot 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
  - getSelfLink
```
public java.lang.String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public Snapshot setSelfLink(java.lang.String selfLink)
```
    [Output Only] Server-defined URL for the resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getSnapshotEncryptionKey
```
public CustomerEncryptionKey getSnapshotEncryptionKey()
```
    Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
    
    Returns:
    
    value or null for none
  - setSnapshotEncryptionKey
```
public Snapshot setSnapshotEncryptionKey(CustomerEncryptionKey snapshotEncryptionKey)
```
    Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later.
    
    Parameters:
    
    snapshotEncryptionKey - snapshotEncryptionKey or null for none
  - getSourceDisk
```
public java.lang.String getSourceDisk()
```
    [Output Only] The source disk used to create this snapshot.
    
    Returns:
    
    value or null for none
  - setSourceDisk
```
public Snapshot setSourceDisk(java.lang.String sourceDisk)
```
    [Output Only] The source disk used to create this snapshot.
    
    Parameters:
    
    sourceDisk - sourceDisk or null for none
  - getSourceDiskEncryptionKey
```
public CustomerEncryptionKey getSourceDiskEncryptionKey()
```
    The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
    
    Returns:
    
    value or null for none
  - setSourceDiskEncryptionKey
```
public Snapshot setSourceDiskEncryptionKey(CustomerEncryptionKey sourceDiskEncryptionKey)
```
    The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
    
    Parameters:
    
    sourceDiskEncryptionKey - sourceDiskEncryptionKey or null for none
  - getSourceDiskId
```
public java.lang.String getSourceDiskId()
```
    [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
    
    Returns:
    
    value or null for none
  - setSourceDiskId
```
public Snapshot setSourceDiskId(java.lang.String sourceDiskId)
```
    [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
    
    Parameters:
    
    sourceDiskId - sourceDiskId or null for none
  - getStatus
```
public java.lang.String getStatus()
```
    [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
    
    Returns:
    
    value or null for none
  - setStatus
```
public Snapshot setStatus(java.lang.String status)
```
    [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
    
    Parameters:
    
    status - status or null for none
  - getStorageBytes
```
public java.lang.Long getStorageBytes()
```
    [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
    
    Returns:
    
    value or null for none
  - setStorageBytes
```
public Snapshot setStorageBytes(java.lang.Long storageBytes)
```
    [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
    
    Parameters:
    
    storageBytes - storageBytes or null for none
  - getStorageBytesStatus
```
public java.lang.String getStorageBytesStatus()
```
    [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to- date.
    
    Returns:
    
    value or null for none
  - setStorageBytesStatus
```
public Snapshot setStorageBytesStatus(java.lang.String storageBytesStatus)
```
    [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to- date.
    
    Parameters:
    
    storageBytesStatus - storageBytesStatus or null for none
  - getStorageLocations
```
public java.util.List<java.lang.String> getStorageLocations()
```
    Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
    
    Returns:
    
    value or null for none
  - setStorageLocations
```
public Snapshot setStorageLocations(java.util.List<java.lang.String> storageLocations)
```
    Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
    
    Parameters:
    
    storageLocations - storageLocations or null for none
  - set
```
public Snapshot set(java.lang.String fieldName,
                    java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Snapshot clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Compute Engine API v1 (revision 235)

Class Snapshot

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

Snapshot

Method Detail

getAutoCreated

setAutoCreated

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getDiskSizeGb

setDiskSizeGb

getDownloadBytes

setDownloadBytes

getId

setId

getKind

setKind

getLabelFingerprint

decodeLabelFingerprint

setLabelFingerprint

encodeLabelFingerprint

getLabels

setLabels

getLicenseCodes

setLicenseCodes

getLicenses

setLicenses

getName

setName

getSelfLink

setSelfLink

getSnapshotEncryptionKey

setSnapshotEncryptionKey

getSourceDisk

setSourceDisk

getSourceDiskEncryptionKey

setSourceDiskEncryptionKey

getSourceDiskId

setSourceDiskId

getStatus

setStatus

getStorageBytes

setStorageBytes

getStorageBytesStatus

setStorageBytesStatus

getStorageLocations

setStorageLocations

set

clone