com.google.api.services.compute

Class Compute.GlobalOperations.Wait

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.GlobalOperations.Wait

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Compute.GlobalOperations

public class Compute.GlobalOperations.Wait
extends ComputeRequest<Operation>

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>

Field Summary

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Wait(String project, String operation) Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource.

Method Summary

Modifier and Type	Method and Description
String	getOperation() Name of the Operations resource to return.
String	getProject() Project ID for this request.
Compute.GlobalOperations.Wait	set(String parameterName, Object value)
Compute.GlobalOperations.Wait	set$Xgafv(String $Xgafv) V1 error format.
Compute.GlobalOperations.Wait	setAccessToken(String accessToken) OAuth access token.
Compute.GlobalOperations.Wait	setAlt(String alt) Data format for response.
Compute.GlobalOperations.Wait	setCallback(String callback) JSONP
Compute.GlobalOperations.Wait	setFields(String fields) Selector specifying which fields to include in a partial response.
Compute.GlobalOperations.Wait	setKey(String key) API key.
Compute.GlobalOperations.Wait	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Compute.GlobalOperations.Wait	setOperation(String operation) Name of the Operations resource to return.
Compute.GlobalOperations.Wait	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Compute.GlobalOperations.Wait	setProject(String project) Project ID for this request.
Compute.GlobalOperations.Wait	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Compute.GlobalOperations.Wait	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Compute.GlobalOperations.Wait	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Compute.GlobalOperations.Wait	setUserIp(String userIp) Legacy name for parameter that has been superseded by `quotaUser`.

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

Wait

protected Wait(String project,
               String operation)

Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. Create a request for the method "globalOperations.wait". 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.

Compute.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

project - Project ID for this request.

operation - Name of the Operations resource to return.

Since:

1.13

Method Detail

set$Xgafv

public Compute.GlobalOperations.Wait set$Xgafv(String $Xgafv)

Description copied from class: ComputeRequest

V1 error format.

Overrides:

set$Xgafv in class ComputeRequest<Operation>

setAccessToken

public Compute.GlobalOperations.Wait setAccessToken(String accessToken)

Description copied from class: ComputeRequest

OAuth access token.

Overrides:

setAccessToken in class ComputeRequest<Operation>

setAlt

public Compute.GlobalOperations.Wait setAlt(String alt)

Description copied from class: ComputeRequest

Data format for response.

Overrides:

setAlt in class ComputeRequest<Operation>

setCallback

public Compute.GlobalOperations.Wait setCallback(String callback)

Description copied from class: ComputeRequest

JSONP

Overrides:

setCallback in class ComputeRequest<Operation>

setFields

public Compute.GlobalOperations.Wait 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.GlobalOperations.Wait 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.GlobalOperations.Wait 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.GlobalOperations.Wait setPrettyPrint(Boolean prettyPrint)

Description copied from class: ComputeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ComputeRequest<Operation>

setQuotaUser

public Compute.GlobalOperations.Wait 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.GlobalOperations.Wait 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.GlobalOperations.Wait 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.GlobalOperations.Wait 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.GlobalOperations.Wait setProject(String project)

Project ID for this request.

getOperation

public String getOperation()

Name of the Operations resource to return.

setOperation

public Compute.GlobalOperations.Wait setOperation(String operation)

Name of the Operations resource to return.

set

public Compute.GlobalOperations.Wait set(String parameterName,
                                         Object value)

Overrides:

set in class ComputeRequest<Operation>