Class TransferOperationsResource

The "transferOperations" collection of methods.

Inheritance

object

TransferOperationsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Storagetransfer.v1

Assembly: Google.Apis.Storagetransfer.v1.dll

Syntax

public class TransferOperationsResource

Constructors

TransferOperationsResource(IClientService)

Constructs a new resource.

Declaration

public TransferOperationsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Cancel(CancelOperationRequest, string)

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.

Declaration

public virtual TransferOperationsResource.CancelRequest Cancel(CancelOperationRequest body, string name)

Parameters

Type	Name	Description
CancelOperationRequest	body	The body of the request.
string	name	The name of the operation resource to be cancelled.

Returns

Type	Description
TransferOperationsResource.CancelRequest

Get(string)

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Declaration

public virtual TransferOperationsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	The name of the operation resource.

Returns

Type	Description
TransferOperationsResource.GetRequest

List(string, string)

Lists transfer operations. Operations are ordered by their creation time in reverse chronological order.

Declaration

public virtual TransferOperationsResource.ListRequest List(string name, string filter)

Parameters

Type	Name	Description
string	name	Required. The name of the type being listed; must be transferOperations.
string	filter	Required. A list of query parameters specified as JSON text in the form of: {"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobNamePattern": "job_name_pattern", "operationNames":["opid1","opid2",...], "operationNamePattern": "operation_name_pattern", "minCreationTime": "min_creation_time", "maxCreationTime": "max_creation_time", "transferStatuses":["status1","status2",...]} Since jobNames, operationNames, and transferStatuses support multiple values, they must be specified with array notation. projectId is the only argument that is required. If specified, jobNamePattern and operationNamePattern must match the full job or operation name respectively. '*' is a wildcard matching 0 or more characters. minCreationTime and maxCreationTime should be timestamps encoded as a string in the RFC 3339 format. The valid values for transferStatuses are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED.

Returns

Type	Description
TransferOperationsResource.ListRequest

Pause(PauseTransferOperationRequest, string)

Pauses a transfer operation.

Declaration

public virtual TransferOperationsResource.PauseRequest Pause(PauseTransferOperationRequest body, string name)

Parameters

Type	Name	Description
PauseTransferOperationRequest	body	The body of the request.
string	name	Required. The name of the transfer operation.

Returns

Type	Description
TransferOperationsResource.PauseRequest

Resume(ResumeTransferOperationRequest, string)

Resumes a transfer operation that is paused.

Declaration

public virtual TransferOperationsResource.ResumeRequest Resume(ResumeTransferOperationRequest body, string name)

Parameters

Type	Name	Description
ResumeTransferOperationRequest	body	The body of the request.
string	name	Required. The name of the transfer operation.

Returns

Type	Description
TransferOperationsResource.ResumeRequest