com.google.api.services.spanner.v1

Class Spanner.Projects.InstanceConfigs.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.spanner.v1.SpannerRequest<Empty>

com.google.api.services.spanner.v1.Spanner.Projects.InstanceConfigs.Operations.Cancel

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Spanner.Projects.InstanceConfigs.Operations

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

Methods inherited from class com.google.api.services.spanner.v1.SpannerRequest

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)

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 spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Spanner.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.

Since:

1.13

Method Detail

set$Xgafv

public Spanner.Projects.InstanceConfigs.Operations.Cancel set$Xgafv(String $Xgafv)

Description copied from class: SpannerRequest

V1 error format.

Overrides:

set$Xgafv in class SpannerRequest<Empty>

setAccessToken

public Spanner.Projects.InstanceConfigs.Operations.Cancel setAccessToken(String accessToken)

Description copied from class: SpannerRequest

OAuth access token.

Overrides:

setAccessToken in class SpannerRequest<Empty>

setAlt

public Spanner.Projects.InstanceConfigs.Operations.Cancel setAlt(String alt)

Description copied from class: SpannerRequest

Data format for response.

Overrides:

setAlt in class SpannerRequest<Empty>

setCallback

public Spanner.Projects.InstanceConfigs.Operations.Cancel setCallback(String callback)

Description copied from class: SpannerRequest

JSONP

Overrides:

setCallback in class SpannerRequest<Empty>

setFields

public Spanner.Projects.InstanceConfigs.Operations.Cancel setFields(String fields)

Description copied from class: SpannerRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class SpannerRequest<Empty>

setKey

public Spanner.Projects.InstanceConfigs.Operations.Cancel setKey(String key)

Description copied from class: SpannerRequest

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

setOauthToken

public Spanner.Projects.InstanceConfigs.Operations.Cancel setOauthToken(String oauthToken)

Description copied from class: SpannerRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class SpannerRequest<Empty>

setPrettyPrint

public Spanner.Projects.InstanceConfigs.Operations.Cancel setPrettyPrint(Boolean prettyPrint)

Description copied from class: SpannerRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class SpannerRequest<Empty>

setQuotaUser

public Spanner.Projects.InstanceConfigs.Operations.Cancel setQuotaUser(String quotaUser)

Description copied from class: SpannerRequest

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

setUploadType

public Spanner.Projects.InstanceConfigs.Operations.Cancel setUploadType(String uploadType)

Description copied from class: SpannerRequest

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

Overrides:

setUploadType in class SpannerRequest<Empty>

setUploadProtocol

public Spanner.Projects.InstanceConfigs.Operations.Cancel setUploadProtocol(String uploadProtocol)

Description copied from class: SpannerRequest

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

Overrides:

setUploadProtocol in class SpannerRequest<Empty>

getName

public String getName()

The name of the operation resource to be cancelled.

setName

public Spanner.Projects.InstanceConfigs.Operations.Cancel setName(String name)

The name of the operation resource to be cancelled.

set

public Spanner.Projects.InstanceConfigs.Operations.Cancel set(String parameterName,
                                                              Object value)

Overrides:

set in class SpannerRequest<Empty>