com.google.api.services.cloudbuild.v2

Class CloudBuild.Projects.Locations.Operations.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.cloudbuild.v2.CloudBuildRequest<Empty>

com.google.api.services.cloudbuild.v2.CloudBuild.Projects.Locations.Operations.Cancel

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

CloudBuild.Projects.Locations.Operations

public class CloudBuild.Projects.Locations.Operations.Cancel
extends CloudBuildRequest<Empty>

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 name, CancelOperationRequest content) Starts asynchronous cancellation on a long-running operation.

Method Summary

Modifier and Type	Method and Description
String	getName() The name of the operation resource to be cancelled.
CloudBuild.Projects.Locations.Operations.Cancel	set(String parameterName, Object value)
CloudBuild.Projects.Locations.Operations.Cancel	set$Xgafv(String $Xgafv) V1 error format.
CloudBuild.Projects.Locations.Operations.Cancel	setAccessToken(String accessToken) OAuth access token.
CloudBuild.Projects.Locations.Operations.Cancel	setAlt(String alt) Data format for response.
CloudBuild.Projects.Locations.Operations.Cancel	setCallback(String callback) JSONP
CloudBuild.Projects.Locations.Operations.Cancel	setFields(String fields) Selector specifying which fields to include in a partial response.
CloudBuild.Projects.Locations.Operations.Cancel	setKey(String key) API key.
CloudBuild.Projects.Locations.Operations.Cancel	setName(String name) The name of the operation resource to be cancelled.
CloudBuild.Projects.Locations.Operations.Cancel	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
CloudBuild.Projects.Locations.Operations.Cancel	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
CloudBuild.Projects.Locations.Operations.Cancel	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
CloudBuild.Projects.Locations.Operations.Cancel	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
CloudBuild.Projects.Locations.Operations.Cancel	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.cloudbuild.v2.CloudBuildRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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 name,
                 CancelOperationRequest content)

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. Create a request for the method "operations.cancel". This request holds the parameters needed by the the cloudbuild server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

name - The name of the operation resource to be cancelled.

content - the CancelOperationRequest

Since:

1.13

Method Detail

set$Xgafv

public CloudBuild.Projects.Locations.Operations.Cancel set$Xgafv(String $Xgafv)

Description copied from class: CloudBuildRequest

V1 error format.

Overrides:

set$Xgafv in class CloudBuildRequest<Empty>

setAccessToken

public CloudBuild.Projects.Locations.Operations.Cancel setAccessToken(String accessToken)

Description copied from class: CloudBuildRequest

OAuth access token.

Overrides:

setAccessToken in class CloudBuildRequest<Empty>

setAlt

public CloudBuild.Projects.Locations.Operations.Cancel setAlt(String alt)

Description copied from class: CloudBuildRequest

Data format for response.

Overrides:

setAlt in class CloudBuildRequest<Empty>

setCallback

public CloudBuild.Projects.Locations.Operations.Cancel setCallback(String callback)

Description copied from class: CloudBuildRequest

JSONP

Overrides:

setCallback in class CloudBuildRequest<Empty>

setFields

public CloudBuild.Projects.Locations.Operations.Cancel setFields(String fields)

Description copied from class: CloudBuildRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CloudBuildRequest<Empty>

setKey

public CloudBuild.Projects.Locations.Operations.Cancel setKey(String key)

Description copied from class: CloudBuildRequest

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 CloudBuildRequest<Empty>

setOauthToken

public CloudBuild.Projects.Locations.Operations.Cancel setOauthToken(String oauthToken)

Description copied from class: CloudBuildRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CloudBuildRequest<Empty>

setPrettyPrint

public CloudBuild.Projects.Locations.Operations.Cancel setPrettyPrint(Boolean prettyPrint)

Description copied from class: CloudBuildRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CloudBuildRequest<Empty>

setQuotaUser

public CloudBuild.Projects.Locations.Operations.Cancel setQuotaUser(String quotaUser)

Description copied from class: CloudBuildRequest

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 CloudBuildRequest<Empty>

setUploadType

public CloudBuild.Projects.Locations.Operations.Cancel setUploadType(String uploadType)

Description copied from class: CloudBuildRequest

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

Overrides:

setUploadType in class CloudBuildRequest<Empty>

setUploadProtocol

public CloudBuild.Projects.Locations.Operations.Cancel setUploadProtocol(String uploadProtocol)

Description copied from class: CloudBuildRequest

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

Overrides:

setUploadProtocol in class CloudBuildRequest<Empty>

getName

public String getName()

The name of the operation resource to be cancelled.

setName

public CloudBuild.Projects.Locations.Operations.Cancel setName(String name)

The name of the operation resource to be cancelled.

set

public CloudBuild.Projects.Locations.Operations.Cancel set(String parameterName,
                                                           Object value)

Overrides:

set in class CloudBuildRequest<Empty>