com.google.api.services.storagetransfer.v1

Class Storagetransfer.TransferOperations

java.lang.Object

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

Enclosing class:

Storagetransfer

public class Storagetransfer.TransferOperations
extends Object

The "transferOperations" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Storagetransfer.TransferOperations.Cancel
class	Storagetransfer.TransferOperations.Get
class	Storagetransfer.TransferOperations.List
class	Storagetransfer.TransferOperations.Pause
class	Storagetransfer.TransferOperations.Resume

Constructor Summary

Constructors

Constructor and Description
TransferOperations()

Method Summary

Modifier and Type	Method and Description
Storagetransfer.TransferOperations.Cancel	cancel(String name, CancelOperationRequest content) Cancels a transfer.
Storagetransfer.TransferOperations.Get	get(String name) Gets the latest state of a long-running operation.
Storagetransfer.TransferOperations.List	list(String name, String filter) Lists transfer operations.
Storagetransfer.TransferOperations.Pause	pause(String name, PauseTransferOperationRequest content) Pauses a transfer operation.
Storagetransfer.TransferOperations.Resume	resume(String name, ResumeTransferOperationRequest content) Resumes a transfer operation that is paused.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransferOperations

public TransferOperations()

Method Detail

cancel

public Storagetransfer.TransferOperations.Cancel cancel(String name,
                                                        CancelOperationRequest content)
                                                 throws IOException

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 storagetransfer server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - The name of the operation resource to be cancelled.

content - the CancelOperationRequest

Returns:

the request

Throws:

IOException

get

public Storagetransfer.TransferOperations.Get get(String name)
                                           throws IOException

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. Create a request for the method "transferOperations.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:

name - The name of the operation resource.

Returns:

the request

Throws:

IOException

list

public Storagetransfer.TransferOperations.List list(String name,
                                                    String filter)
                                             throws IOException

Lists transfer operations. Operations are ordered by their creation time in reverse chronological order. Create a request for the method "transferOperations.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:

name - Required. The name of the type being listed; must be `transferOperations`.

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](https://www.ietf.org/rfc/rfc3339.txt) format. The valid values for `transferStatuses` are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED.

Returns:

the request

Throws:

IOException

pause

public Storagetransfer.TransferOperations.Pause pause(String name,
                                                      PauseTransferOperationRequest content)
                                               throws IOException

Pauses a transfer operation. Create a request for the method "transferOperations.pause". 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:

name - Required. The name of the transfer operation.

content - the PauseTransferOperationRequest

Returns:

the request

Throws:

IOException

resume

public Storagetransfer.TransferOperations.Resume resume(String name,
                                                        ResumeTransferOperationRequest content)
                                                 throws IOException

Resumes a transfer operation that is paused. Create a request for the method "transferOperations.resume". 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:

name - Required. The name of the transfer operation.

content - the ResumeTransferOperationRequest

Returns:

the request

Throws:

IOException