com.google.api.services.compute

Class Compute.OrganizationRollouts.Cancel

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.OrganizationRollouts.Cancel

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Compute.OrganizationRollouts

public class Compute.OrganizationRollouts.Cancel
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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Cancel(String organization, String rollout) Cancels a Rollout.

Method Summary

Modifier and Type	Method and Description
String	getOrganization() Required.
String	getRequestId() An optional request ID to identify requests.
Boolean	getRollback() Optional.
String	getRollout() Name of the Rollout resource to cancel.
Compute.OrganizationRollouts.Cancel	set(String parameterName, Object value)
Compute.OrganizationRollouts.Cancel	set$Xgafv(String $Xgafv) V1 error format.
Compute.OrganizationRollouts.Cancel	setAccessToken(String accessToken) OAuth access token.
Compute.OrganizationRollouts.Cancel	setAlt(String alt) Data format for response.
Compute.OrganizationRollouts.Cancel	setCallback(String callback) JSONP
Compute.OrganizationRollouts.Cancel	setFields(String fields) Selector specifying which fields to include in a partial response.
Compute.OrganizationRollouts.Cancel	setKey(String key) API key.
Compute.OrganizationRollouts.Cancel	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Compute.OrganizationRollouts.Cancel	setOrganization(String organization) Required.
Compute.OrganizationRollouts.Cancel	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Compute.OrganizationRollouts.Cancel	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Compute.OrganizationRollouts.Cancel	setRequestId(String requestId) An optional request ID to identify requests.
Compute.OrganizationRollouts.Cancel	setRollback(Boolean rollback) Optional.
Compute.OrganizationRollouts.Cancel	setRollout(String rollout) Name of the Rollout resource to cancel.
Compute.OrganizationRollouts.Cancel	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Compute.OrganizationRollouts.Cancel	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
Compute.OrganizationRollouts.Cancel	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

Cancel

protected Cancel(String organization,
                 String rollout)

Cancels a Rollout. Create a request for the method "organizationRollouts.cancel". 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:

organization - Required. Organization ID for this request.

rollout - Name of the Rollout resource to cancel.

Since:

1.13

Method Detail

set$Xgafv

public Compute.OrganizationRollouts.Cancel set$Xgafv(String $Xgafv)

Description copied from class: ComputeRequest

V1 error format.

Overrides:

set$Xgafv in class ComputeRequest<Operation>

setAccessToken

public Compute.OrganizationRollouts.Cancel setAccessToken(String accessToken)

Description copied from class: ComputeRequest

OAuth access token.

Overrides:

setAccessToken in class ComputeRequest<Operation>

setAlt

public Compute.OrganizationRollouts.Cancel setAlt(String alt)

Description copied from class: ComputeRequest

Data format for response.

Overrides:

setAlt in class ComputeRequest<Operation>

setCallback

public Compute.OrganizationRollouts.Cancel setCallback(String callback)

Description copied from class: ComputeRequest

JSONP

Overrides:

setCallback in class ComputeRequest<Operation>

setFields

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

Description copied from class: ComputeRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ComputeRequest<Operation>

setQuotaUser

public Compute.OrganizationRollouts.Cancel 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.OrganizationRollouts.Cancel 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.OrganizationRollouts.Cancel 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.OrganizationRollouts.Cancel setUserIp(String userIp)

Description copied from class: ComputeRequest

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

Overrides:

setUserIp in class ComputeRequest<Operation>

getOrganization

public String getOrganization()

Required. Organization ID for this request.

setOrganization

public Compute.OrganizationRollouts.Cancel setOrganization(String organization)

Required. Organization ID for this request.

getRollout

public String getRollout()

Name of the Rollout resource to cancel.

setRollout

public Compute.OrganizationRollouts.Cancel setRollout(String rollout)

Name of the Rollout resource to cancel.

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.OrganizationRollouts.Cancel 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).

getRollback

public Boolean getRollback()

Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel the rollout without taking any further actions. Note that products must support at least one of these options, however, it does not need to support both.

setRollback

public Compute.OrganizationRollouts.Cancel setRollback(Boolean rollback)

Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel the rollout without taking any further actions. Note that products must support at least one of these options, however, it does not need to support both.

set

public Compute.OrganizationRollouts.Cancel set(String parameterName,
                                               Object value)

Overrides:

set in class ComputeRequest<Operation>