Documentation

Google_Service_Storagetransfer_Resource_TransferJobs extends Google_Service_Resource
in package

Application

The "transferJobs" collection of methods.

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

$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.
create() : Google_Service_Storagetransfer_TransferJob: Creates a transfer job that runs periodically. (transferJobs.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
get() : Google_Service_Storagetransfer_TransferJob: Gets a transfer job. (transferJobs.get)
listTransferJobs() : Google_Service_Storagetransfer_ListTransferJobsResponse: Lists transfer jobs. (transferJobs.listTransferJobs)
patch() : Google_Service_Storagetransfer_TransferJob: Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Updating a job's schedule is not allowed. **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).
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 —

create()

Creates a transfer job that runs periodically. (transferJobs.create)


    public
                create(Google_Service_Storagetransfer_TransferJob $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storagetransfer_TransferJob

Parameters

$postBody : Google_Service_Storagetransfer_TransferJob
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storagetransfer_TransferJob —

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 a transfer job. (transferJobs.get)


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

Parameters

$jobName : string: " Required. The job to get.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storagetransfer_TransferJob —

listTransferJobs()

Lists transfer jobs. (transferJobs.listTransferJobs)


    public
                listTransferJobs([array<string|int, mixed> $optParams = array() ]) : Google_Service_Storagetransfer_ListTransferJobsResponse

Parameters

$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storagetransfer_ListTransferJobsResponse —

patch()

Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Updating a job's schedule is not allowed. **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).


    public
                patch(string $jobName, Google_Service_Storagetransfer_UpdateTransferJobRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storagetransfer_TransferJob

(transferJobs.patch)

Parameters

$jobName : string: Required. The name of job to update.
$postBody : Google_Service_Storagetransfer_UpdateTransferJobRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storagetransfer_TransferJob —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —