
target.apidocs.com.google.api.services.compute.model.InPlaceSnapshot.html Maven / Gradle / Ivy
InPlaceSnapshot (Compute Engine API alpha-rev20200526-1.30.9)
com.google.api.services.compute.model
Class InPlaceSnapshot
- 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.InPlaceSnapshot
-
public final class InPlaceSnapshot
extends GenericJson
Represents a InPlaceSnapshot resource.
You can use in-place snapshots to create disk rollback points quickly.. (== resource_for
{$api_version}.inPlaceSnapshots ==)
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
GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
InPlaceSnapshot()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
InPlaceSnapshot
clone()
byte[]
decodeLabelFingerprint()
A fingerprint for the labels being applied to this InPlaceSnapshot, which is essentially a hash
of the labels set used for optimistic locking.
InPlaceSnapshot
encodeLabelFingerprint(byte[] labelFingerprint)
A fingerprint for the labels being applied to this InPlaceSnapshot, which is essentially a hash
of the labels set used for optimistic locking.
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.
Boolean
getGuestFlush()
Specifies to create an application consistent in-place snapshot by informing the OS to prepare
for the snapshot process.
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 InPlaceSnapshot, which is essentially a hash
of the labels set used for optimistic locking.
Map<String,String>
getLabels()
Labels to apply to this InPlaceSnapshot.
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 in-place snapshot resides.
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 in-place snapshot.
String
getSourceDiskId()
[Output Only] The ID value of the disk used to create this InPlaceSnapshot.
String
getStatus()
[Output Only] The status of the inPlaceSnapshot.
String
getZone()
[Output Only] URL of the zone where the in-place snapshot resides.
InPlaceSnapshot
set(String fieldName,
Object value)
InPlaceSnapshot
setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.
InPlaceSnapshot
setDescription(String description)
An optional description of this resource.
InPlaceSnapshot
setDiskSizeGb(Long diskSizeGb)
[Output Only] Size of the source disk, specified in GB.
InPlaceSnapshot
setGuestFlush(Boolean guestFlush)
Specifies to create an application consistent in-place snapshot by informing the OS to prepare
for the snapshot process.
InPlaceSnapshot
setId(BigInteger id)
[Output Only] The unique identifier for the resource.
InPlaceSnapshot
setKind(String kind)
[Output Only] Type of the resource.
InPlaceSnapshot
setLabelFingerprint(String labelFingerprint)
A fingerprint for the labels being applied to this InPlaceSnapshot, which is essentially a hash
of the labels set used for optimistic locking.
InPlaceSnapshot
setLabels(Map<String,String> labels)
Labels to apply to this InPlaceSnapshot.
InPlaceSnapshot
setName(String name)
Name of the resource; provided by the client when the resource is created.
InPlaceSnapshot
setRegion(String region)
[Output Only] URL of the region where the in-place snapshot resides.
InPlaceSnapshot
setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.
InPlaceSnapshot
setSelfLinkWithId(String selfLinkWithId)
[Output Only] Server-defined URL for this resource's resource id.
InPlaceSnapshot
setSourceDisk(String sourceDisk)
URL of the source disk used to create this in-place snapshot.
InPlaceSnapshot
setSourceDiskId(String sourceDiskId)
[Output Only] The ID value of the disk used to create this InPlaceSnapshot.
InPlaceSnapshot
setStatus(String status)
[Output Only] The status of the inPlaceSnapshot.
InPlaceSnapshot
setZone(String zone)
[Output Only] URL of the zone where the in-place 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
-
-
Method Detail
-
getCreationTimestamp
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
- Returns:
- value or
null
for none
-
setCreationTimestamp
public InPlaceSnapshot 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 InPlaceSnapshot 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 InPlaceSnapshot setDiskSizeGb(Long diskSizeGb)
[Output Only] Size of the source disk, specified in GB.
- Parameters:
diskSizeGb
- diskSizeGb or null
for none
-
getGuestFlush
public Boolean getGuestFlush()
Specifies to create an application consistent in-place snapshot by informing the OS to prepare
for the snapshot process. Currently only supported on Windows instances using the Volume Shadow
Copy Service (VSS).
- Returns:
- value or
null
for none
-
setGuestFlush
public InPlaceSnapshot setGuestFlush(Boolean guestFlush)
Specifies to create an application consistent in-place snapshot by informing the OS to prepare
for the snapshot process. Currently only supported on Windows instances using the Volume Shadow
Copy Service (VSS).
- Parameters:
guestFlush
- guestFlush 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 InPlaceSnapshot 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#inPlaceSnapshot for InPlaceSnapshot
resources.
- Returns:
- value or
null
for none
-
setKind
public InPlaceSnapshot setKind(String kind)
[Output Only] Type of the resource. Always compute#inPlaceSnapshot for InPlaceSnapshot
resources.
- Parameters:
kind
- kind or null
for none
-
getLabelFingerprint
public String getLabelFingerprint()
A fingerprint for the labels being applied to this InPlaceSnapshot, 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 InPlaceSnapshot.
- Returns:
- value or
null
for none
- See Also:
decodeLabelFingerprint()
-
decodeLabelFingerprint
public byte[] decodeLabelFingerprint()
A fingerprint for the labels being applied to this InPlaceSnapshot, 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 InPlaceSnapshot.
- Returns:
- Base64 decoded value or
null
for none
- Since:
- 1.14
- See Also:
getLabelFingerprint()
-
setLabelFingerprint
public InPlaceSnapshot setLabelFingerprint(String labelFingerprint)
A fingerprint for the labels being applied to this InPlaceSnapshot, 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 InPlaceSnapshot.
- Parameters:
labelFingerprint
- labelFingerprint or null
for none
- See Also:
#encodeLabelFingerprint()
-
encodeLabelFingerprint
public InPlaceSnapshot encodeLabelFingerprint(byte[] labelFingerprint)
A fingerprint for the labels being applied to this InPlaceSnapshot, 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 InPlaceSnapshot.
- 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 InPlaceSnapshot. These can be later modified by the setLabels method.
Label values may be empty.
- Returns:
- value or
null
for none
-
setLabels
public InPlaceSnapshot setLabels(Map<String,String> labels)
Labels to apply to this InPlaceSnapshot. 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 InPlaceSnapshot 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 in-place 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 InPlaceSnapshot setRegion(String region)
[Output Only] URL of the region where the in-place 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
-
getSelfLink
public String getSelfLink()
[Output Only] Server-defined URL for the resource.
- Returns:
- value or
null
for none
-
setSelfLink
public InPlaceSnapshot 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 InPlaceSnapshot 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 in-place snapshot. Note that the source disk must be
in the same zone/region as the in-place 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 -
projects/project/zones/zone/disks/disk - zones/zone/disks/disk
- Returns:
- value or
null
for none
-
setSourceDisk
public InPlaceSnapshot setSourceDisk(String sourceDisk)
URL of the source disk used to create this in-place snapshot. Note that the source disk must be
in the same zone/region as the in-place 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 -
projects/project/zones/zone/disks/disk - zones/zone/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 InPlaceSnapshot. This value may be
used to determine whether the InPlaceSnapshot was taken from the current or a previous instance
of a given disk name.
- Returns:
- value or
null
for none
-
setSourceDiskId
public InPlaceSnapshot setSourceDiskId(String sourceDiskId)
[Output Only] The ID value of the disk used to create this InPlaceSnapshot. This value may be
used to determine whether the InPlaceSnapshot 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 inPlaceSnapshot. This can be CREATING, DELETING, FAILED, or
READY.
- Returns:
- value or
null
for none
-
setStatus
public InPlaceSnapshot setStatus(String status)
[Output Only] The status of the inPlaceSnapshot. 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 in-place 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 InPlaceSnapshot setZone(String zone)
[Output Only] URL of the zone where the in-place 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 InPlaceSnapshot set(String fieldName,
Object value)
- Overrides:
set
in class GenericJson
-
clone
public InPlaceSnapshot clone()
- Overrides:
clone
in class GenericJson
Copyright © 2011–2020 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy