Class TransferJobsResource

The "transferJobs" collection of methods.

Inheritance
object
TransferJobsResource
Inherited Members
Namespace: Google.Apis.Storagetransfer.v1
Assembly: Google.Apis.Storagetransfer.v1.dll
Syntax
public class TransferJobsResource

Constructors

TransferJobsResource(IClientService)

Constructs a new resource.

Declaration
public TransferJobsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Create(TransferJob)

Creates a transfer job that runs periodically.

Declaration
public virtual TransferJobsResource.CreateRequest Create(TransferJob body)
Parameters
Type Name Description
TransferJob body

The body of the request.
Returns
Type Description
TransferJobsResource.CreateRequest

Delete(string, string)

Deletes a transfer job. Deleting a transfer job sets its status to DELETED.

Declaration
public virtual TransferJobsResource.DeleteRequest Delete(string jobName, string projectId)
Parameters
Type Name Description
string jobName

Required. The job to delete.
string projectId

Required. The ID of the Google Cloud project that owns the job.
Returns
Type Description
TransferJobsResource.DeleteRequest

Get(string, string)

Gets a transfer job.

Declaration
public virtual TransferJobsResource.GetRequest Get(string jobName, string projectId)
Parameters
Type Name Description
string jobName

Required. The job to get.
string projectId

Required. The ID of the Google Cloud project that owns the job.
Returns
Type Description
TransferJobsResource.GetRequest

List(string)

Lists transfer jobs.

Declaration
public virtual TransferJobsResource.ListRequest List(string filter)
Parameters
Type Name Description
string filter

Required. A list of query parameters specified as JSON text in the form of:

{
"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobStatuses":["status1","status2",...],
"dataBackend":"QUERY_REPLICATION_CONFIGS", "sourceBucket":"source-bucket-name",
"sinkBucket":"sink-bucket-name", }

The JSON formatting in the example is for display only; provide the query parameters without spaces or line breaks. * projectId is required. * Since jobNames and jobStatuses support multiple values, their values must be specified with array notation. jobNames and jobStatuses are optional. Valid values are case-insensitive: * ENABLED * DISABLED * DELETED * Specify "dataBackend":"QUERY_REPLICATION_CONFIGS" to return a list of cross-bucket replication jobs. * Limit the results to jobs from a particular bucket with sourceBucket and/or to a particular bucket with sinkBucket.
Returns
Type Description
TransferJobsResource.ListRequest

Patch(UpdateTransferJobRequest, string)

Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Note: The job's status field can be modified using this RPC (for example, to set a job's status to DELETED, DISABLED, or ENABLED).

Declaration
public virtual TransferJobsResource.PatchRequest Patch(UpdateTransferJobRequest body, string jobName)
Parameters
Type Name Description
UpdateTransferJobRequest body

The body of the request.
string jobName

Required. The name of job to update.
Returns
Type Description
TransferJobsResource.PatchRequest

Run(RunTransferJobRequest, string)

Starts a new operation for the specified transfer job. A TransferJob has a maximum of one active TransferOperation. If this method is called while a TransferOperation is active, an error is returned.

Declaration
public virtual TransferJobsResource.RunRequest Run(RunTransferJobRequest body, string jobName)
Parameters
Type Name Description
RunTransferJobRequest body

The body of the request.
string jobName

Required. The name of the transfer job.
Returns
Type Description
TransferJobsResource.RunRequest