Class TransferOperationsResource.CancelRequest

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.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Empty>
StoragetransferBaseServiceRequest<Empty>
TransferOperationsResource.CancelRequest
Implements
Inherited Members
Namespace: Google.Apis.Storagetransfer.v1
Assembly: Google.Apis.Storagetransfer.v1.dll
Syntax
public class TransferOperationsResource.CancelRequest : StoragetransferBaseServiceRequest<Empty>, IClientServiceRequest<Empty>, IClientServiceRequest

Constructors

CancelRequest(IClientService, CancelOperationRequest, string)

Constructs a new Cancel request.

Declaration
public CancelRequest(IClientService service, CancelOperationRequest body, string name)
Parameters
Type Name Description
IClientService service
CancelOperationRequest body
string name

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Name

The name of the operation resource to be cancelled.

Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides

InitParameters()

Initializes Cancel parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements