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