com.google.api.services.storagetransfer.v1

Class Storagetransfer.TransferOperations.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.storagetransfer.v1.StoragetransferRequest<Empty>

com.google.api.services.storagetransfer.v1.Storagetransfer.TransferOperations.Cancel

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storagetransfer.TransferOperations

public class Storagetransfer.TransferOperations.Cancel
extends StoragetransferRequest<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) Cancels a transfer.

Method Summary

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

Methods inherited from class com.google.api.services.storagetransfer.v1.StoragetransferRequest

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)

Cancels a transfer. Use the transferOperations.get method to check if the cancellation succeeded or if the operation completed despite the `cancel` request. When you cancel an operation, the currently running transfer is interrupted. For recurring transfer jobs, the next instance of the transfer job will still run. For example, if your job is configured to run every day at 1pm and you cancel Monday's operation at 1:05pm, Monday's transfer will stop. However, a transfer job will still be attempted on Tuesday. This applies only to currently running operations. If an operation is not currently running, `cancel` does nothing. *Caution:* Canceling a transfer job can leave your data in an unknown state. We recommend that you restore the state at both the destination and the source after the `cancel` request completes so that your data is in a consistent state. When you cancel a job, the next job computes a delta of files and may repair any inconsistent state. For instance, if you run a job every day, and today's job found 10 new files and transferred five files before you canceled the job, tomorrow's transfer operation will compute a new delta with the five files that were not copied today plus any new files discovered tomorrow. Create a request for the method "transferOperations.cancel". This request holds the parameters needed by the the storagetransfer server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Storagetransfer.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 Storagetransfer.TransferOperations.Cancel set$Xgafv(String $Xgafv)

Description copied from class: StoragetransferRequest

V1 error format.

Overrides:

set$Xgafv in class StoragetransferRequest<Empty>

setAccessToken

public Storagetransfer.TransferOperations.Cancel setAccessToken(String accessToken)

Description copied from class: StoragetransferRequest

OAuth access token.

Overrides:

setAccessToken in class StoragetransferRequest<Empty>

setAlt

public Storagetransfer.TransferOperations.Cancel setAlt(String alt)

Description copied from class: StoragetransferRequest

Data format for response.

Overrides:

setAlt in class StoragetransferRequest<Empty>

setCallback

public Storagetransfer.TransferOperations.Cancel setCallback(String callback)

Description copied from class: StoragetransferRequest

JSONP

Overrides:

setCallback in class StoragetransferRequest<Empty>

setFields

public Storagetransfer.TransferOperations.Cancel setFields(String fields)

Description copied from class: StoragetransferRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class StoragetransferRequest<Empty>

setKey

public Storagetransfer.TransferOperations.Cancel setKey(String key)

Description copied from class: StoragetransferRequest

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

setOauthToken

public Storagetransfer.TransferOperations.Cancel setOauthToken(String oauthToken)

Description copied from class: StoragetransferRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class StoragetransferRequest<Empty>

setPrettyPrint

public Storagetransfer.TransferOperations.Cancel setPrettyPrint(Boolean prettyPrint)

Description copied from class: StoragetransferRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class StoragetransferRequest<Empty>

setQuotaUser

public Storagetransfer.TransferOperations.Cancel setQuotaUser(String quotaUser)

Description copied from class: StoragetransferRequest

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

setUploadType

public Storagetransfer.TransferOperations.Cancel setUploadType(String uploadType)

Description copied from class: StoragetransferRequest

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

Overrides:

setUploadType in class StoragetransferRequest<Empty>

setUploadProtocol

public Storagetransfer.TransferOperations.Cancel setUploadProtocol(String uploadProtocol)

Description copied from class: StoragetransferRequest

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

Overrides:

setUploadProtocol in class StoragetransferRequest<Empty>

getName

public String getName()

The name of the operation resource to be cancelled.

setName

public Storagetransfer.TransferOperations.Cancel setName(String name)

The name of the operation resource to be cancelled.

set

public Storagetransfer.TransferOperations.Cancel set(String parameterName,
                                                     Object value)

Overrides:

set in class StoragetransferRequest<Empty>