target.apidocs.com.google.api.services.batch.v1.Batch.Projects.Locations.Operations.Cancel.html Maven / Gradle / Ivy
Batch.Projects.Locations.Operations.Cancel (Batch API v1-rev20230914-2.0.0)
com.google.api.services.batch.v1
Class Batch.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.batch.v1.BatchRequest<Empty>
-
- com.google.api.services.batch.v1.Batch.Projects.Locations.Operations.Cancel
-
- Enclosing class:
- Batch.Projects.Locations.Operations
public class Batch.Projects.Locations.Operations.Cancel
extends BatchRequest<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>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected Cancel(String name,
CancelOperationRequest content)
Starts asynchronous cancellation on a long-running operation.
-
Method Summary
-
Methods inherited from class com.google.api.services.batch.v1.BatchRequest
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 batch server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation. Batch.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 Batch.Projects.Locations.Operations.Cancel set$Xgafv(String $Xgafv)
Description copied from class: BatchRequest
V1 error format.
- Overrides:
set$Xgafv in class BatchRequest<Empty>
-
setAccessToken
public Batch.Projects.Locations.Operations.Cancel setAccessToken(String accessToken)
Description copied from class: BatchRequest
OAuth access token.
- Overrides:
setAccessToken in class BatchRequest<Empty>
-
setAlt
public Batch.Projects.Locations.Operations.Cancel setAlt(String alt)
Description copied from class: BatchRequest
Data format for response.
- Overrides:
setAlt in class BatchRequest<Empty>
-
setCallback
public Batch.Projects.Locations.Operations.Cancel setCallback(String callback)
Description copied from class: BatchRequest
JSONP
- Overrides:
setCallback in class BatchRequest<Empty>
-
setFields
public Batch.Projects.Locations.Operations.Cancel setFields(String fields)
Description copied from class: BatchRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class BatchRequest<Empty>
-
setKey
public Batch.Projects.Locations.Operations.Cancel setKey(String key)
Description copied from class: BatchRequest
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 BatchRequest<Empty>
-
setOauthToken
public Batch.Projects.Locations.Operations.Cancel setOauthToken(String oauthToken)
Description copied from class: BatchRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class BatchRequest<Empty>
-
setPrettyPrint
public Batch.Projects.Locations.Operations.Cancel setPrettyPrint(Boolean prettyPrint)
Description copied from class: BatchRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class BatchRequest<Empty>
-
setQuotaUser
public Batch.Projects.Locations.Operations.Cancel setQuotaUser(String quotaUser)
Description copied from class: BatchRequest
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 BatchRequest<Empty>
-
setUploadType
public Batch.Projects.Locations.Operations.Cancel setUploadType(String uploadType)
Description copied from class: BatchRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class BatchRequest<Empty>
-
setUploadProtocol
public Batch.Projects.Locations.Operations.Cancel setUploadProtocol(String uploadProtocol)
Description copied from class: BatchRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class BatchRequest<Empty>
-
getName
public String getName()
The name of the operation resource to be cancelled.
-
setName
public Batch.Projects.Locations.Operations.Cancel setName(String name)
The name of the operation resource to be cancelled.
-
set
public Batch.Projects.Locations.Operations.Cancel set(String parameterName,
Object value)
- Overrides:
set in class BatchRequest<Empty>
Copyright © 2011–2023 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy