Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Storagetransfer_TransferJobs_Resource Class Reference

The "transferJobs" collection of methods. More...

Inheritance diagram for Google_Service_Storagetransfer_TransferJobs_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 create (Google_Service_Storagetransfer_TransferJob $postBody, $optParams=array())
 Creates a transfer job that runs periodically.
 
 get ($jobName, $optParams=array())
 Gets a transfer job.
 
 listTransferJobs ($optParams=array())
 Lists transfer jobs.
 
 patch ($jobName, Google_Service_Storagetransfer_UpdateTransferJobRequest $postBody, $optParams=array())
 Updates a transfer job.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "transferJobs" collection of methods.

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

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ create()

Google_Service_Storagetransfer_TransferJobs_Resource::create ( Google_Service_Storagetransfer_TransferJob $postBody,
$optParams = array() )

Creates a transfer job that runs periodically.

(transferJobs.create)

Parameters
Google_TransferJob$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Storagetransfer_TransferJob

◆ get()

Google_Service_Storagetransfer_TransferJobs_Resource::get ( $jobName,
$optParams = array() )

Gets a transfer job.

(transferJobs.get)

Parameters
string$jobNameThe job to get. Required.
array$optParamsOptional parameters.

@opt_param string projectId The ID of the Google Developers Console project that owns the job. Required.

Return values
Google_Service_Storagetransfer_TransferJob

◆ listTransferJobs()

Google_Service_Storagetransfer_TransferJobs_Resource::listTransferJobs ( $optParams = array())

Lists transfer jobs.

(transferJobs.listTransferJobs)

Parameters
array$optParamsOptional parameters.

@opt_param string filter A list of query parameters specified as JSON text in the form of {"`project_id`":"my_project_id", "`job_names`":["jobid1","jobid2",...], "`job_statuses`":["status1","status2",...]}. Since job_names and job_statuses support multiple values, their values must be specified with array notation. project_id is required. job_names and job_statuses are optional. The valid values for job_statuses are case-insensitive: ENABLED, DISABLED, and DELETED. @opt_param string pageToken The list page token. @opt_param int pageSize The list page size. The max allowed value is 256.

Return values
Google_Service_Storagetransfer_ListTransferJobsResponse

◆ patch()

Google_Service_Storagetransfer_TransferJobs_Resource::patch ( $jobName,
Google_Service_Storagetransfer_UpdateTransferJobRequest $postBody,
$optParams = array() )

Updates a transfer job.

Updating a job's transfer spec does not affect transfer operations that are running already. Updating the scheduling of a job is not allowed. (transferJobs.patch)

Parameters
string$jobNameThe name of job to update. Required.
Google_UpdateTransferJobRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Storagetransfer_TransferJob

The documentation for this class was generated from the following file: