Documentation

Google_Service_Storagetransfer_Resource_TransferOperations extends Google_Service_Resource
in package

Application

The "transferOperations" collection of methods.

Typical usage is: $storagetransferService = new Google_Service_Storagetransfer(...); $transferOperations = $storagetransferService->transferOperations;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
cancel() : Google_Service_Storagetransfer_StoragetransferEmpty: 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.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
get() : Google_Service_Storagetransfer_Operation: 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)
listTransferOperations() : Google_Service_Storagetransfer_ListOperationsResponse: Lists transfer operations. (transferOperations.listTransferOperations)
pause() : Google_Service_Storagetransfer_StoragetransferEmpty: Pauses a transfer operation. (transferOperations.pause)
resume() : Google_Service_Storagetransfer_StoragetransferEmpty: Resumes a transfer operation that is paused. (transferOperations.resume)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

cancel()

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.


    public
                cancel(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storagetransfer_StoragetransferEmpty

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)

Parameters

$name : string: The name of the operation resource to be cancelled.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storagetransfer_StoragetransferEmpty —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

get()

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)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storagetransfer_Operation

Parameters

$name : string: The name of the operation resource.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storagetransfer_Operation —

listTransferOperations()

Lists transfer operations. (transferOperations.listTransferOperations)


    public
                listTransferOperations(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storagetransfer_ListOperationsResponse

Parameters

$name : string: Required. The value transferOperations.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storagetransfer_ListOperationsResponse —

pause()

Pauses a transfer operation. (transferOperations.pause)


    public
                pause(string $name, Google_Service_Storagetransfer_PauseTransferOperationRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storagetransfer_StoragetransferEmpty

Parameters

$name : string: Required. The name of the transfer operation.
$postBody : Google_Service_Storagetransfer_PauseTransferOperationRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storagetransfer_StoragetransferEmpty —

resume()

Resumes a transfer operation that is paused. (transferOperations.resume)


    public
                resume(string $name, Google_Service_Storagetransfer_ResumeTransferOperationRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storagetransfer_StoragetransferEmpty

Parameters

$name : string: Required. The name of the transfer operation.
$postBody : Google_Service_Storagetransfer_ResumeTransferOperationRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storagetransfer_StoragetransferEmpty —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —