Snapshot.Builder (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.Snapshot.Builder

Enclosing class:: Snapshot

public static class Snapshot.Builder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Snapshot.Builder`	`addAllLicenseCodes(List<String> licenseCodes)` [Output Only] Integer license codes indicating which licenses are attached to this snapshot.
`Snapshot.Builder`	`addAllLicenses(List<String> licenses)` [Output Only] A list of public visible licenses that apply to this snapshot.
`Snapshot.Builder`	`addAllStorageLocations(List<String> storageLocations)` Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
`Snapshot.Builder`	`addLicenseCodes(String licenseCodes)` [Output Only] Integer license codes indicating which licenses are attached to this snapshot.
`Snapshot.Builder`	`addLicenses(String licenses)` [Output Only] A list of public visible licenses that apply to this snapshot.
`Snapshot.Builder`	`addStorageLocations(String storageLocations)` Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
`Snapshot`	`build()`
`Snapshot.Builder`	`clone()`
`Boolean`	`getAutoCreated()` [Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk.
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`String`	`getDescription()` An optional description of this resource.
`String`	`getDiskSizeGb()` [Output Only] Size of the snapshot, specified in GB.
`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()` Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
`Snapshot.Builder`	`mergeFrom(Snapshot other)`
`Snapshot.Builder`	`putAllLabels(Map<String,String> labels)` Labels to apply to this snapshot.
`Snapshot.Builder`	`setAutoCreated(Boolean autoCreated)` [Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk.
`Snapshot.Builder`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`Snapshot.Builder`	`setDescription(String description)` An optional description of this resource.
`Snapshot.Builder`	`setDiskSizeGb(String diskSizeGb)` [Output Only] Size of the snapshot, specified in GB.
`Snapshot.Builder`	`setId(String id)` [Output Only] The unique identifier for the resource.
`Snapshot.Builder`	`setKind(String kind)` [Output Only] Type of the resource.
`Snapshot.Builder`	`setLabelFingerprint(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.Builder`	`setName(String name)` Name of the resource; provided by the client when the resource is created.
`Snapshot.Builder`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.
`Snapshot.Builder`	`setSnapshotEncryptionKey(CustomerEncryptionKey snapshotEncryptionKey)` Encrypts the snapshot using a customer-supplied encryption key.
`Snapshot.Builder`	`setSourceDisk(String sourceDisk)` [Output Only] The source disk used to create this snapshot.
`Snapshot.Builder`	`setSourceDiskEncryptionKey(CustomerEncryptionKey sourceDiskEncryptionKey)` The customer-supplied encryption key of the source disk.
`Snapshot.Builder`	`setSourceDiskId(String sourceDiskId)` [Output Only] The ID value of the disk used to create this snapshot.
`Snapshot.Builder`	`setStatus(String status)` [Output Only] The status of the snapshot.
`Snapshot.Builder`	`setStorageBytes(String storageBytes)` [Output Only] A size of the storage used by the snapshot.
`Snapshot.Builder`	`setStorageBytesStatus(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.

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

- Method Detail
  - mergeFrom
```
public Snapshot.Builder mergeFrom(Snapshot other)
```
  - getAutoCreated
```
public Boolean getAutoCreated()
```
    [Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk.
  - setAutoCreated
```
public Snapshot.Builder setAutoCreated(Boolean autoCreated)
```
    [Output Only] Set to true if snapshots are automatically by applying resource policy on the target disk.
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
  - setCreationTimestamp
```
public Snapshot.Builder setCreationTimestamp(String creationTimestamp)
```
    [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.
  - setDescription
```
public Snapshot.Builder setDescription(String description)
```
    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.
  - setDiskSizeGb
```
public Snapshot.Builder setDiskSizeGb(String diskSizeGb)
```
    [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.
  - setId
```
public Snapshot.Builder setId(String id)
```
    [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.
  - setKind
```
public Snapshot.Builder setKind(String kind)
```
    [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.
  - setLabelFingerprint
```
public Snapshot.Builder setLabelFingerprint(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.
  - 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.
  - putAllLabels
```
public Snapshot.Builder putAllLabels(Map<String,String> labels)
```
    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.
  - addAllLicenseCodes
```
public Snapshot.Builder addAllLicenseCodes(List<String> licenseCodes)
```
    [Output Only] Integer license codes indicating which licenses are attached to this snapshot.
  - addLicenseCodes
```
public Snapshot.Builder addLicenseCodes(String licenseCodes)
```
    [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).
  - addAllLicenses
```
public Snapshot.Builder addAllLicenses(List<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).
  - addLicenses
```
public Snapshot.Builder addLicenses(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).
  - 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.
  - setName
```
public Snapshot.Builder 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.
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
  - setSelfLink
```
public Snapshot.Builder setSelfLink(String selfLink)
```
    [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 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.
  - setSnapshotEncryptionKey
```
public Snapshot.Builder 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.
  - getSourceDisk
```
public String getSourceDisk()
```
    [Output Only] The source disk used to create this snapshot.
  - setSourceDisk
```
public Snapshot.Builder setSourceDisk(String sourceDisk)
```
    [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.
  - setSourceDiskEncryptionKey
```
public Snapshot.Builder 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.
  - 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.
  - setSourceDiskId
```
public Snapshot.Builder setSourceDiskId(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.
  - getStatus
```
public String getStatus()
```
    [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
  - setStatus
```
public Snapshot.Builder setStatus(String status)
```
    [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.
  - setStorageBytes
```
public Snapshot.Builder setStorageBytes(String 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.
  - 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.
  - setStorageBytesStatus
```
public Snapshot.Builder setStorageBytesStatus(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.
  - getStorageLocationsList
```
public List<String> getStorageLocationsList()
```
    Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
  - addAllStorageLocations
```
public Snapshot.Builder addAllStorageLocations(List<String> storageLocations)
```
    Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
  - addStorageLocations
```
public Snapshot.Builder addStorageLocations(String storageLocations)
```
    Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
  - build
```
public Snapshot build()
```
  - clone
```
public Snapshot.Builder clone()
```
    Overrides:
    
    clone in class Object

Class Snapshot.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

mergeFrom

getAutoCreated

setAutoCreated

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getDiskSizeGb

setDiskSizeGb

getId

setId

getKind

setKind

getLabelFingerprint

setLabelFingerprint

getLabelsMap

putAllLabels

getLicenseCodesList

addAllLicenseCodes

addLicenseCodes

getLicensesList

addAllLicenses

addLicenses

getName

setName

getSelfLink

setSelfLink

getSnapshotEncryptionKey

setSnapshotEncryptionKey

getSourceDisk

setSourceDisk

getSourceDiskEncryptionKey

setSourceDiskEncryptionKey

getSourceDiskId

setSourceDiskId

getStatus

setStatus

getStorageBytes

setStorageBytes

getStorageBytesStatus

setStorageBytesStatus

getStorageLocationsList

addAllStorageLocations

addStorageLocations

build

clone