com.google.cloud.compute.v1

Class Snapshot

java.lang.Object

com.google.cloud.compute.v1.Snapshot

All Implemented Interfaces:

ApiMessage

@Generated(value="by GAPIC")
 @BetaApi
public final class Snapshot
extends Object
implements ApiMessage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Snapshot.Builder

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ApiMessage	getApiMessageRequestBody()
String	getCreationTimestamp() [Output Only] Creation timestamp in RFC3339 text format.
static Snapshot	getDefaultInstance()
String	getDescription() An optional description of this resource.
String	getDiskSizeGb() [Output Only] Size of the snapshot, specified in GB.
List<String>	getFieldMask()
Object	getFieldValue(String fieldName)
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 snapshot, which is essentially a hash of the labels set used for optimistic locking.
Map<String,String>	getLabelsMap() Labels to apply to this snapshot.
List<String>	getLicenseCodesList() [Output Only] Integer license codes indicating which licenses are attached to this snapshot.
List<String>	getLicensesList() [Output Only] A list of public visible licenses that apply to this snapshot.
String	getName() Name of the resource; provided by the client when the resource is created.
String	getSelfLink() [Output Only] Server-defined URL for the resource.
CustomerEncryptionKey	getSnapshotEncryptionKey() Encrypts the snapshot using a customer-supplied encryption key.
String	getSourceDisk() [Output Only] The source disk used to create this snapshot.
CustomerEncryptionKey	getSourceDiskEncryptionKey() The customer-supplied encryption key of the source disk.
String	getSourceDiskId() [Output Only] The ID value of the disk used to create this snapshot.
String	getStatus() [Output Only] The status of the snapshot.
String	getStorageBytes() [Output Only] A size of the storage used by the snapshot.
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.
List<String>	getStorageLocationsList() GCS bucket storage location of the snapshot (regional or multi-regional).
int	hashCode()
static Snapshot.Builder	newBuilder()
static Snapshot.Builder	newBuilder(Snapshot prototype)
Snapshot.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 ApiMessage

getApiMessageRequestBody

@Nullable
public ApiMessage getApiMessageRequestBody()

Specified by:

getApiMessageRequestBody in interface ApiMessage

getFieldMask

@Nullable
public List<String> getFieldMask()

Specified by:

getFieldMask in interface 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.

getDiskSizeGb

public String getDiskSizeGb()

[Output Only] Size of the snapshot, specified in GB.

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#snapshot for Snapshot resources.

getLabelFingerprint

public 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.

getLabelsMap

public Map<String,String> getLabelsMap()

Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.

getLicenseCodesList

public List<String> getLicenseCodesList()

[Output Only] Integer license codes indicating which licenses are attached to this snapshot.

getLicensesList

public List<String> getLicensesList()

[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).

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.

getSelfLink

public String getSelfLink()

[Output Only] Server-defined URL for the resource.

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 image 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 disk.

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.

getSourceDisk

public String getSourceDisk()

[Output Only] The source disk used to create this snapshot.

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.

getSourceDiskId

public 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.

getStatus

public String getStatus()

[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.

getStorageBytes

public String 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.

getStorageBytesStatus

public 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.

getStorageLocationsList

public List<String> getStorageLocationsList()

GCS bucket storage location of the snapshot (regional or multi-regional).

newBuilder

public static Snapshot.Builder newBuilder()

newBuilder

public static Snapshot.Builder newBuilder(Snapshot prototype)

toBuilder

public Snapshot.Builder toBuilder()

getDefaultInstance

public static Snapshot 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