target.apidocs.com.google.api.services.compute.Compute.RegionOperations.Wait.html Maven / Gradle / Ivy
Compute.RegionOperations.Wait (Compute Engine API alpha-rev20200526-1.30.9)
com.google.api.services.compute
Class Compute.RegionOperations.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.RegionOperations.Wait
-
- Enclosing class:
- Compute.RegionOperations
public class Compute.RegionOperations.Wait
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>
-
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 region,
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
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
String
getOperation()
Name of the Operations resource to return.
String
getProject()
Project ID for this request.
String
getRegion()
Name of the region for this request.
Compute.RegionOperations.Wait
set(String parameterName,
Object value)
Compute.RegionOperations.Wait
setAlt(String alt)
Data format for the response.
Compute.RegionOperations.Wait
setFields(String fields)
Selector specifying which fields to include in a partial response.
Compute.RegionOperations.Wait
setKey(String key)
API key.
Compute.RegionOperations.Wait
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Compute.RegionOperations.Wait
setOperation(String operation)
Name of the Operations resource to return.
Compute.RegionOperations.Wait
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Compute.RegionOperations.Wait
setProject(String project)
Project ID for this request.
Compute.RegionOperations.Wait
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.
Compute.RegionOperations.Wait
setRegion(String region)
Name of the region for this request.
Compute.RegionOperations.Wait
setUserIp(String userIp)
Deprecated.
-
Methods inherited from class com.google.api.services.compute.ComputeRequest
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, 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 region,
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 "regionOperations.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.
region
- Name of the region for this request.
operation
- Name of the Operations resource to return.
- Since:
- 1.13
-
Method Detail
-
setAlt
public Compute.RegionOperations.Wait setAlt(String alt)
Description copied from class: ComputeRequest
Data format for the response.
- Overrides:
setAlt
in class ComputeRequest<Operation>
-
setFields
public Compute.RegionOperations.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.RegionOperations.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.RegionOperations.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.RegionOperations.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.RegionOperations.Wait setQuotaUser(String quotaUser)
Description copied from class: ComputeRequest
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- Overrides:
setQuotaUser
in class ComputeRequest<Operation>
-
setUserIp
public Compute.RegionOperations.Wait setUserIp(String userIp)
Description copied from class: ComputeRequest
Deprecated. Please use quotaUser instead.
- Overrides:
setUserIp
in class ComputeRequest<Operation>
-
getProject
public String getProject()
Project ID for this request.
-
setProject
public Compute.RegionOperations.Wait setProject(String project)
Project ID for this request.
-
getRegion
public String getRegion()
Name of the region for this request.
-
setRegion
public Compute.RegionOperations.Wait setRegion(String region)
Name of the region for this request.
-
getOperation
public String getOperation()
Name of the Operations resource to return.
-
setOperation
public Compute.RegionOperations.Wait setOperation(String operation)
Name of the Operations resource to return.
-
set
public Compute.RegionOperations.Wait set(String parameterName,
Object value)
- Overrides:
set
in class ComputeRequest<Operation>
Copyright © 2011–2020 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy