TransferOperations
class TransferOperations extends Resource (View source)
The "transferOperations" collection of methods.
Typical usage is:
$storagetransferService = new Google\Service\Storagetransfer(...);
$transferOperations = $storagetransferService->transferOperations;Methods
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.
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. (transferOperations.get)
Lists transfer operations. Operations are ordered by their creation time in reverse chronological order. (transferOperations.listTransferOperations)
Pauses a transfer operation. (transferOperations.pause)
Resumes a transfer operation that is paused. (transferOperations.resume)
Details
StoragetransferEmpty
cancel(string $name, CancelOperationRequest $postBody, array $optParams = [])
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. (transferOperations.cancel)
Operation
get(string $name, array $optParams = [])
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. (transferOperations.get)
ListOperationsResponse
listTransferOperations(string $name, string $filter, array $optParams = [])
Lists transfer operations. Operations are ordered by their creation time in reverse chronological order. (transferOperations.listTransferOperations)
StoragetransferEmpty
pause(string $name, PauseTransferOperationRequest $postBody, array $optParams = [])
Pauses a transfer operation. (transferOperations.pause)
StoragetransferEmpty
resume(string $name, ResumeTransferOperationRequest $postBody, array $optParams = [])
Resumes a transfer operation that is paused. (transferOperations.resume)