target.apidocs.com.google.api.services.compute.model.InstantSnapshot.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

There is a newer version: v1-rev20240903-2.0.0

Show newest version







InstantSnapshot (Compute Engine API v1-rev20240919-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class InstantSnapshot



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.compute.model.InstantSnapshot













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class InstantSnapshot
extends com.google.api.client.json.GenericJson
Represents a InstantSnapshot resource. You can use instant snapshots to create disk rollback
 points quickly..

  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
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


InstantSnapshot() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


InstantSnapshot
clone() 


byte[]
decodeLabelFingerprint()
A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash
 of the labels set used for optimistic locking.



InstantSnapshot
encodeLabelFingerprint(byte[] labelFingerprint)
A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash
 of the labels set used for optimistic locking.



String
getArchitecture()
[Output Only] The architecture of the instant snapshot.



String
getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.



String
getDescription()
An optional description of this resource.



Long
getDiskSizeGb()
[Output Only] Size of the source disk, specified in GB.



BigInteger
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 InstantSnapshot, which is essentially a hash
 of the labels set used for optimistic locking.



Map<String,String>
getLabels()
Labels to apply to this InstantSnapshot.



String
getName()
Name of the resource; provided by the client when the resource is created.



String
getRegion()
[Output Only] URL of the region where the instant snapshot resides.



InstantSnapshotResourceStatus
getResourceStatus()
[Output Only] Status information for the instant snapshot resource.



Boolean
getSatisfiesPzi()
Output only.



Boolean
getSatisfiesPzs()
[Output Only] Reserved for future use.



String
getSelfLink()
[Output Only] Server-defined URL for the resource.



String
getSelfLinkWithId()
[Output Only] Server-defined URL for this resource's resource id.



String
getSourceDisk()
URL of the source disk used to create this instant snapshot.



String
getSourceDiskId()
[Output Only] The ID value of the disk used to create this InstantSnapshot.



String
getStatus()
[Output Only] The status of the instantSnapshot.



String
getZone()
[Output Only] URL of the zone where the instant snapshot resides.



InstantSnapshot
set(String fieldName,
   Object value) 


InstantSnapshot
setArchitecture(String architecture)
[Output Only] The architecture of the instant snapshot.



InstantSnapshot
setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.



InstantSnapshot
setDescription(String description)
An optional description of this resource.



InstantSnapshot
setDiskSizeGb(Long diskSizeGb)
[Output Only] Size of the source disk, specified in GB.



InstantSnapshot
setId(BigInteger id)
[Output Only] The unique identifier for the resource.



InstantSnapshot
setKind(String kind)
[Output Only] Type of the resource.



InstantSnapshot
setLabelFingerprint(String labelFingerprint)
A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash
 of the labels set used for optimistic locking.



InstantSnapshot
setLabels(Map<String,String> labels)
Labels to apply to this InstantSnapshot.



InstantSnapshot
setName(String name)
Name of the resource; provided by the client when the resource is created.



InstantSnapshot
setRegion(String region)
[Output Only] URL of the region where the instant snapshot resides.



InstantSnapshot
setResourceStatus(InstantSnapshotResourceStatus resourceStatus)
[Output Only] Status information for the instant snapshot resource.



InstantSnapshot
setSatisfiesPzi(Boolean satisfiesPzi)
Output only.



InstantSnapshot
setSatisfiesPzs(Boolean satisfiesPzs)
[Output Only] Reserved for future use.



InstantSnapshot
setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.



InstantSnapshot
setSelfLinkWithId(String selfLinkWithId)
[Output Only] Server-defined URL for this resource's resource id.



InstantSnapshot
setSourceDisk(String sourceDisk)
URL of the source disk used to create this instant snapshot.



InstantSnapshot
setSourceDiskId(String sourceDiskId)
[Output Only] The ID value of the disk used to create this InstantSnapshot.



InstantSnapshot
setStatus(String status)
[Output Only] The status of the instantSnapshot.



InstantSnapshot
setZone(String zone)
[Output Only] URL of the zone where the instant snapshot 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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, 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





InstantSnapshot
public InstantSnapshot()









Method Detail





getArchitecture
public String getArchitecture()
[Output Only] The architecture of the instant snapshot. Valid values are ARM64 or X86_64.

Returns:
value or null for none








setArchitecture
public InstantSnapshot setArchitecture(String architecture)
[Output Only] The architecture of the instant snapshot. Valid values are ARM64 or X86_64.

Parameters:
architecture - architecture or null for none








getCreationTimestamp
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.

Returns:
value or null for none








setCreationTimestamp
public InstantSnapshot setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.

Parameters:
creationTimestamp - creationTimestamp or null for none








getDescription
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.

Returns:
value or null for none








setDescription
public InstantSnapshot setDescription(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 Long getDiskSizeGb()
[Output Only] Size of the source disk, specified in GB.

Returns:
value or null for none








setDiskSizeGb
public InstantSnapshot setDiskSizeGb(Long diskSizeGb)
[Output Only] Size of the source disk, specified in GB.

Parameters:
diskSizeGb - diskSizeGb or null for none








getId
public 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 InstantSnapshot setId(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 String getKind()
[Output Only] Type of the resource. Always compute#instantSnapshot for InstantSnapshot
 resources.

Returns:
value or null for none








setKind
public InstantSnapshot setKind(String kind)
[Output Only] Type of the resource. Always compute#instantSnapshot for InstantSnapshot
 resources.

Parameters:
kind - kind or null for none








getLabelFingerprint
public String getLabelFingerprint()
A fingerprint for the labels being applied to this InstantSnapshot, 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 InstantSnapshot.

Returns:
value or null for none
See Also:
decodeLabelFingerprint()








decodeLabelFingerprint
public byte[] decodeLabelFingerprint()
A fingerprint for the labels being applied to this InstantSnapshot, 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 InstantSnapshot.

Returns:
Base64 decoded value or null for none
Since:
1.14
See Also:
getLabelFingerprint()








setLabelFingerprint
public InstantSnapshot setLabelFingerprint(String labelFingerprint)
A fingerprint for the labels being applied to this InstantSnapshot, 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 InstantSnapshot.

Parameters:
labelFingerprint - labelFingerprint or null for none
See Also:
#encodeLabelFingerprint()








encodeLabelFingerprint
public InstantSnapshot encodeLabelFingerprint(byte[] labelFingerprint)
A fingerprint for the labels being applied to this InstantSnapshot, 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 InstantSnapshot.

Since:
1.14
See Also:

 The value is encoded Base64 or {@code null} for none.
 








getLabels
public Map<String,String> getLabels()
Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method.
 Label values may be empty.

Returns:
value or null for none








setLabels
public InstantSnapshot setLabels(Map<String,String> labels)
Labels to apply to this InstantSnapshot. These can be later modified by the setLabels method.
 Label values may be empty.

Parameters:
labels - labels or null for none








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.

Returns:
value or null for none








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

Parameters:
name - name or null for none








getRegion
public String getRegion()
[Output Only] URL of the region where the instant snapshot resides. You must specify this field
 as part of the HTTP request URL. It is not settable as a field in the request body.

Returns:
value or null for none








setRegion
public InstantSnapshot setRegion(String region)
[Output Only] URL of the region where the instant snapshot resides. You must specify this field
 as part of the HTTP request URL. It is not settable as a field in the request body.

Parameters:
region - region or null for none








getResourceStatus
public InstantSnapshotResourceStatus getResourceStatus()
[Output Only] Status information for the instant snapshot resource.

Returns:
value or null for none








setResourceStatus
public InstantSnapshot setResourceStatus(InstantSnapshotResourceStatus resourceStatus)
[Output Only] Status information for the instant snapshot resource.

Parameters:
resourceStatus - resourceStatus or null for none








getSatisfiesPzi
public Boolean getSatisfiesPzi()
Output only. Reserved for future use.

Returns:
value or null for none








setSatisfiesPzi
public InstantSnapshot setSatisfiesPzi(Boolean satisfiesPzi)
Output only. Reserved for future use.

Parameters:
satisfiesPzi - satisfiesPzi or null for none








getSatisfiesPzs
public Boolean getSatisfiesPzs()
[Output Only] Reserved for future use.

Returns:
value or null for none








setSatisfiesPzs
public InstantSnapshot setSatisfiesPzs(Boolean satisfiesPzs)
[Output Only] Reserved for future use.

Parameters:
satisfiesPzs - satisfiesPzs or null for none








getSelfLink
public String getSelfLink()
[Output Only] Server-defined URL for the resource.

Returns:
value or null for none








setSelfLink
public InstantSnapshot setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.

Parameters:
selfLink - selfLink or null for none








getSelfLinkWithId
public String getSelfLinkWithId()
[Output Only] Server-defined URL for this resource's resource id.

Returns:
value or null for none








setSelfLinkWithId
public InstantSnapshot setSelfLinkWithId(String selfLinkWithId)
[Output Only] Server-defined URL for this resource's resource id.

Parameters:
selfLinkWithId - selfLinkWithId or null for none








getSourceDisk
public String getSourceDisk()
URL of the source disk used to create this instant snapshot. Note that the source disk must be
 in the same zone/region as the instant snapshot to be created. This can be a full or valid
 partial URL. For example, the following are valid values: -
 https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk -
 https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk -
 projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk -
 zones/zone/disks/disk - regions/region/disks/disk

Returns:
value or null for none








setSourceDisk
public InstantSnapshot setSourceDisk(String sourceDisk)
URL of the source disk used to create this instant snapshot. Note that the source disk must be
 in the same zone/region as the instant snapshot to be created. This can be a full or valid
 partial URL. For example, the following are valid values: -
 https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk -
 https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk -
 projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk -
 zones/zone/disks/disk - regions/region/disks/disk

Parameters:
sourceDisk - sourceDisk or null for none








getSourceDiskId
public String getSourceDiskId()
[Output Only] The ID value of the disk used to create this InstantSnapshot. This value may be
 used to determine whether the InstantSnapshot was taken from the current or a previous instance
 of a given disk name.

Returns:
value or null for none








setSourceDiskId
public InstantSnapshot setSourceDiskId(String sourceDiskId)
[Output Only] The ID value of the disk used to create this InstantSnapshot. This value may be
 used to determine whether the InstantSnapshot was taken from the current or a previous instance
 of a given disk name.

Parameters:
sourceDiskId - sourceDiskId or null for none








getStatus
public String getStatus()
[Output Only] The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or
 READY.

Returns:
value or null for none








setStatus
public InstantSnapshot setStatus(String status)
[Output Only] The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or
 READY.

Parameters:
status - status or null for none








getZone
public String getZone()
[Output Only] URL of the zone where the instant snapshot resides. You must specify this field
 as part of the HTTP request URL. It is not settable as a field in the request body.

Returns:
value or null for none








setZone
public InstantSnapshot setZone(String zone)
[Output Only] URL of the zone where the instant snapshot resides. You must specify this field
 as part of the HTTP request URL. It is not settable as a field in the request body.

Parameters:
zone - zone or null for none








set
public InstantSnapshot set(String fieldName,
                           Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public InstantSnapshot clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`InstantSnapshot`	`clone()`
`byte[]`	`decodeLabelFingerprint()` A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash of the labels set used for optimistic locking.
`InstantSnapshot`	`encodeLabelFingerprint(byte[] labelFingerprint)` A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash of the labels set used for optimistic locking.
`String`	`getArchitecture()` [Output Only] The architecture of the instant snapshot.
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`String`	`getDescription()` An optional description of this resource.
`Long`	`getDiskSizeGb()` [Output Only] Size of the source disk, specified in GB.
`BigInteger`	`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 InstantSnapshot, which is essentially a hash of the labels set used for optimistic locking.
`Map<String,String>`	`getLabels()` Labels to apply to this InstantSnapshot.
`String`	`getName()` Name of the resource; provided by the client when the resource is created.
`String`	`getRegion()` [Output Only] URL of the region where the instant snapshot resides.
`InstantSnapshotResourceStatus`	`getResourceStatus()` [Output Only] Status information for the instant snapshot resource.
`Boolean`	`getSatisfiesPzi()` Output only.
`Boolean`	`getSatisfiesPzs()` [Output Only] Reserved for future use.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`String`	`getSelfLinkWithId()` [Output Only] Server-defined URL for this resource's resource id.
`String`	`getSourceDisk()` URL of the source disk used to create this instant snapshot.
`String`	`getSourceDiskId()` [Output Only] The ID value of the disk used to create this InstantSnapshot.
`String`	`getStatus()` [Output Only] The status of the instantSnapshot.
`String`	`getZone()` [Output Only] URL of the zone where the instant snapshot resides.
`InstantSnapshot`	`set(String fieldName, Object value)`
`InstantSnapshot`	`setArchitecture(String architecture)` [Output Only] The architecture of the instant snapshot.
`InstantSnapshot`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`InstantSnapshot`	`setDescription(String description)` An optional description of this resource.
`InstantSnapshot`	`setDiskSizeGb(Long diskSizeGb)` [Output Only] Size of the source disk, specified in GB.
`InstantSnapshot`	`setId(BigInteger id)` [Output Only] The unique identifier for the resource.
`InstantSnapshot`	`setKind(String kind)` [Output Only] Type of the resource.
`InstantSnapshot`	`setLabelFingerprint(String labelFingerprint)` A fingerprint for the labels being applied to this InstantSnapshot, which is essentially a hash of the labels set used for optimistic locking.
`InstantSnapshot`	`setLabels(Map<String,String> labels)` Labels to apply to this InstantSnapshot.
`InstantSnapshot`	`setName(String name)` Name of the resource; provided by the client when the resource is created.
`InstantSnapshot`	`setRegion(String region)` [Output Only] URL of the region where the instant snapshot resides.
`InstantSnapshot`	`setResourceStatus(InstantSnapshotResourceStatus resourceStatus)` [Output Only] Status information for the instant snapshot resource.
`InstantSnapshot`	`setSatisfiesPzi(Boolean satisfiesPzi)` Output only.
`InstantSnapshot`	`setSatisfiesPzs(Boolean satisfiesPzs)` [Output Only] Reserved for future use.
`InstantSnapshot`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.
`InstantSnapshot`	`setSelfLinkWithId(String selfLinkWithId)` [Output Only] Server-defined URL for this resource's resource id.
`InstantSnapshot`	`setSourceDisk(String sourceDisk)` URL of the source disk used to create this instant snapshot.
`InstantSnapshot`	`setSourceDiskId(String sourceDiskId)` [Output Only] The ID value of the disk used to create this InstantSnapshot.
`InstantSnapshot`	`setStatus(String status)` [Output Only] The status of the instantSnapshot.
`InstantSnapshot`	`setZone(String zone)` [Output Only] URL of the zone where the instant snapshot resides.