com.google.api.services.storagetransfer.v1

Class Storagetransfer.TransferJobs

java.lang.Object

com.google.api.services.storagetransfer.v1.Storagetransfer.TransferJobs

Enclosing class:

Storagetransfer

public class Storagetransfer.TransferJobs
extends Object

The "transferJobs" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Storagetransfer.TransferJobs.Create
class	Storagetransfer.TransferJobs.Delete
class	Storagetransfer.TransferJobs.Get
class	Storagetransfer.TransferJobs.List
class	Storagetransfer.TransferJobs.Patch
class	Storagetransfer.TransferJobs.Run

Constructor Summary

Constructors

Constructor and Description
TransferJobs()

Method Summary

Modifier and Type	Method and Description
Storagetransfer.TransferJobs.Create	create(TransferJob content) Creates a transfer job that runs periodically.
Storagetransfer.TransferJobs.Delete	delete(String jobName, String projectId) Deletes a transfer job.
Storagetransfer.TransferJobs.Get	get(String jobName, String projectId) Gets a transfer job.
Storagetransfer.TransferJobs.List	list(String filter) Lists transfer jobs.
Storagetransfer.TransferJobs.Patch	patch(String jobName, UpdateTransferJobRequest content) Updates a transfer job.
Storagetransfer.TransferJobs.Run	run(String jobName, RunTransferJobRequest content) Starts a new operation for the specified transfer job.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransferJobs

public TransferJobs()

Method Detail

create

public Storagetransfer.TransferJobs.Create create(TransferJob content)
                                           throws IOException

Creates a transfer job that runs periodically. Create a request for the method "transferJobs.create". This request holds the parameters needed by the storagetransfer server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the TransferJob

Returns:

the request

Throws:

IOException

delete

public Storagetransfer.TransferJobs.Delete delete(String jobName,
                                                  String projectId)
                                           throws IOException

Deletes a transfer job. Deleting a transfer job sets its status to DELETED. Create a request for the method "transferJobs.delete". This request holds the parameters needed by the storagetransfer server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

jobName - Required. The job to delete.

projectId - Required. The ID of the Google Cloud project that owns the job.

Returns:

the request

Throws:

IOException

get

public Storagetransfer.TransferJobs.Get get(String jobName,
                                            String projectId)
                                     throws IOException

Gets a transfer job. Create a request for the method "transferJobs.get". This request holds the parameters needed by the storagetransfer server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

jobName - Required. The job to get.

projectId - Required. The ID of the Google Cloud project that owns the job.

Returns:

the request

Throws:

IOException

list

public Storagetransfer.TransferJobs.List list(String filter)
                                       throws IOException

Lists transfer jobs. Create a request for the method "transferJobs.list". This request holds the parameters needed by the storagetransfer server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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",...]}` Since `jobNames` and `jobStatuses` support multiple values, their values must be specified with array notation. `projectId` is required. `jobNames` and `jobStatuses` are optional. The valid values for `jobStatuses` are case-insensitive: ENABLED, DISABLED, and DELETED.

Returns:

the request

Throws:

IOException

patch

public Storagetransfer.TransferJobs.Patch patch(String jobName,
                                                UpdateTransferJobRequest content)
                                         throws IOException

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). Create a request for the method "transferJobs.patch". This request holds the parameters needed by the storagetransfer server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

jobName - Required. The name of job to update.

content - the UpdateTransferJobRequest

Returns:

the request

Throws:

IOException

run

public Storagetransfer.TransferJobs.Run run(String jobName,
                                            RunTransferJobRequest content)
                                     throws IOException

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. Create a request for the method "transferJobs.run". This request holds the parameters needed by the storagetransfer server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

jobName - Required. The name of the transfer job.

content - the RunTransferJobRequest

Returns:

the request

Throws:

IOException