target.apidocs.com.google.api.services.drive.Drive.Operation.Cancel.html Maven / Gradle / Ivy
Drive.Operation.Cancel (Google Drive API v3-rev20240914-2.0.0)
com.google.api.services.drive
Class Drive.Operation.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.drive.DriveRequest<Void>
-
- com.google.api.services.drive.Drive.Operation.Cancel
-
- Enclosing class:
- Drive.Operation
public class Drive.Operation.Cancel
extends DriveRequest<Void>
-
-
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
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
String
getName()
The name of the operation resource to be cancelled.
Drive.Operation.Cancel
set(String parameterName,
Object value)
Drive.Operation.Cancel
set$Xgafv(String $Xgafv)
V1 error format.
Drive.Operation.Cancel
setAccessToken(String accessToken)
OAuth access token.
Drive.Operation.Cancel
setAlt(String alt)
Data format for response.
Drive.Operation.Cancel
setCallback(String callback)
JSONP
Drive.Operation.Cancel
setFields(String fields)
Selector specifying which fields to include in a partial response.
Drive.Operation.Cancel
setKey(String key)
API key.
Drive.Operation.Cancel
setName(String name)
The name of the operation resource to be cancelled.
Drive.Operation.Cancel
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Drive.Operation.Cancel
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Drive.Operation.Cancel
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
Drive.Operation.Cancel
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
Drive.Operation.Cancel
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
-
Methods inherited from class com.google.api.services.drive.DriveRequest
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 "operation.cancel".
This request holds the parameters needed by the the drive server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation. Drive.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 Drive.Operation.Cancel set$Xgafv(String $Xgafv)
Description copied from class: DriveRequest
V1 error format.
- Overrides:
set$Xgafv
in class DriveRequest<Void>
-
setAccessToken
public Drive.Operation.Cancel setAccessToken(String accessToken)
Description copied from class: DriveRequest
OAuth access token.
- Overrides:
setAccessToken
in class DriveRequest<Void>
-
setAlt
public Drive.Operation.Cancel setAlt(String alt)
Description copied from class: DriveRequest
Data format for response.
- Overrides:
setAlt
in class DriveRequest<Void>
-
setCallback
public Drive.Operation.Cancel setCallback(String callback)
Description copied from class: DriveRequest
JSONP
- Overrides:
setCallback
in class DriveRequest<Void>
-
setFields
public Drive.Operation.Cancel setFields(String fields)
Description copied from class: DriveRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class DriveRequest<Void>
-
setKey
public Drive.Operation.Cancel setKey(String key)
Description copied from class: DriveRequest
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 DriveRequest<Void>
-
setOauthToken
public Drive.Operation.Cancel setOauthToken(String oauthToken)
Description copied from class: DriveRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class DriveRequest<Void>
-
setPrettyPrint
public Drive.Operation.Cancel setPrettyPrint(Boolean prettyPrint)
Description copied from class: DriveRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class DriveRequest<Void>
-
setQuotaUser
public Drive.Operation.Cancel setQuotaUser(String quotaUser)
Description copied from class: DriveRequest
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 DriveRequest<Void>
-
setUploadType
public Drive.Operation.Cancel setUploadType(String uploadType)
Description copied from class: DriveRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class DriveRequest<Void>
-
setUploadProtocol
public Drive.Operation.Cancel setUploadProtocol(String uploadProtocol)
Description copied from class: DriveRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class DriveRequest<Void>
-
getName
public String getName()
The name of the operation resource to be cancelled.
-
setName
public Drive.Operation.Cancel setName(String name)
The name of the operation resource to be cancelled.
-
set
public Drive.Operation.Cancel set(String parameterName,
Object value)
- Overrides:
set
in class DriveRequest<Void>
Copyright © 2011–2024 Google. All rights reserved.