com.google.api.services.compute

Class Compute.Disks.CreateSnapshot

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.compute.ComputeRequest<Operation>

com.google.api.services.compute.Compute.Disks.CreateSnapshot

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Compute.Disks

public class Compute.Disks.CreateSnapshot
extends ComputeRequest<Operation>

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>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CreateSnapshot(String project, String zone, String disk, Snapshot content) Creates a snapshot of a specified persistent disk.

Method Summary

Modifier and Type	Method and Description
String	getDisk() Name of the persistent disk to snapshot.
Boolean	getGuestFlush() [ Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare [ for the snapshot process.
String	getProject() Project ID for this request.
String	getRequestId() An optional request ID to identify requests.
String	getZone() The name of the zone for this request.
Compute.Disks.CreateSnapshot	set(String parameterName, Object value)
Compute.Disks.CreateSnapshot	set$Xgafv(String $Xgafv) V1 error format.
Compute.Disks.CreateSnapshot	setAccessToken(String accessToken) OAuth access token.
Compute.Disks.CreateSnapshot	setAlt(String alt) Data format for response.
Compute.Disks.CreateSnapshot	setCallback(String callback) JSONP
Compute.Disks.CreateSnapshot	setDisk(String disk) Name of the persistent disk to snapshot.
Compute.Disks.CreateSnapshot	setFields(String fields) Selector specifying which fields to include in a partial response.
Compute.Disks.CreateSnapshot	setGuestFlush(Boolean guestFlush) [Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.
Compute.Disks.CreateSnapshot	setKey(String key) API key.
Compute.Disks.CreateSnapshot	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Compute.Disks.CreateSnapshot	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Compute.Disks.CreateSnapshot	setProject(String project) Project ID for this request.
Compute.Disks.CreateSnapshot	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Compute.Disks.CreateSnapshot	setRequestId(String requestId) An optional request ID to identify requests.
Compute.Disks.CreateSnapshot	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Compute.Disks.CreateSnapshot	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Compute.Disks.CreateSnapshot	setUserIp(String userIp) Legacy name for parameter that has been superseded by `quotaUser`.
Compute.Disks.CreateSnapshot	setZone(String zone) The name of the zone for this request.

Methods inherited from class com.google.api.services.compute.ComputeRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

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

CreateSnapshot

protected CreateSnapshot(String project,
                         String zone,
                         String disk,
                         Snapshot content)

Creates a snapshot of a specified persistent disk. Create a request for the method "disks.createSnapshot". This request holds the parameters needed by the the compute server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

CreateSnapshot#initialize(com.google.api.client.googleapis.services.AbstractGoogleCl ientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

project - Project ID for this request.

zone - The name of the zone for this request.

disk - Name of the persistent disk to snapshot.

content - the Snapshot

Since:

1.13

Method Detail

set$Xgafv

public Compute.Disks.CreateSnapshot set$Xgafv(String $Xgafv)

Description copied from class: ComputeRequest

V1 error format.

Overrides:

set$Xgafv in class ComputeRequest<Operation>

setAccessToken

public Compute.Disks.CreateSnapshot setAccessToken(String accessToken)

Description copied from class: ComputeRequest

OAuth access token.

Overrides:

setAccessToken in class ComputeRequest<Operation>

setAlt

public Compute.Disks.CreateSnapshot setAlt(String alt)

Description copied from class: ComputeRequest

Data format for response.

Overrides:

setAlt in class ComputeRequest<Operation>

setCallback

public Compute.Disks.CreateSnapshot setCallback(String callback)

Description copied from class: ComputeRequest

JSONP

Overrides:

setCallback in class ComputeRequest<Operation>

setFields

public Compute.Disks.CreateSnapshot setFields(String fields)

Description copied from class: ComputeRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ComputeRequest<Operation>

setKey

public Compute.Disks.CreateSnapshot setKey(String key)

Description copied from class: ComputeRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class ComputeRequest<Operation>

setOauthToken

public Compute.Disks.CreateSnapshot setOauthToken(String oauthToken)

Description copied from class: ComputeRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ComputeRequest<Operation>

setPrettyPrint

public Compute.Disks.CreateSnapshot setPrettyPrint(Boolean prettyPrint)

Description copied from class: ComputeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ComputeRequest<Operation>

setQuotaUser

public Compute.Disks.CreateSnapshot setQuotaUser(String quotaUser)

Description copied from class: ComputeRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class ComputeRequest<Operation>

setUploadType

public Compute.Disks.CreateSnapshot setUploadType(String uploadType)

Description copied from class: ComputeRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class ComputeRequest<Operation>

setUploadProtocol

public Compute.Disks.CreateSnapshot setUploadProtocol(String uploadProtocol)

Description copied from class: ComputeRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class ComputeRequest<Operation>

setUserIp

public Compute.Disks.CreateSnapshot setUserIp(String userIp)

Description copied from class: ComputeRequest

Legacy name for parameter that has been superseded by `quotaUser`.

Overrides:

setUserIp in class ComputeRequest<Operation>

getProject

public String getProject()

Project ID for this request.

setProject

public Compute.Disks.CreateSnapshot setProject(String project)

Project ID for this request.

getZone

public String getZone()

The name of the zone for this request.

setZone

public Compute.Disks.CreateSnapshot setZone(String zone)

The name of the zone for this request.

getDisk

public String getDisk()

Name of the persistent disk to snapshot.

setDisk

public Compute.Disks.CreateSnapshot setDisk(String disk)

Name of the persistent disk to snapshot.

getGuestFlush

public Boolean getGuestFlush()

[ Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare [ for the snapshot process. Currently only supported on Windows instances using the Volume Shadow [ Copy Service (VSS). [

setGuestFlush

public Compute.Disks.CreateSnapshot setGuestFlush(Boolean guestFlush)

[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS).

getRequestId

public String getRequestId()

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

setRequestId

public Compute.Disks.CreateSnapshot setRequestId(String requestId)

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

set

public Compute.Disks.CreateSnapshot set(String parameterName,
                                        Object value)

Overrides:

set in class ComputeRequest<Operation>