Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
Google_Service_Dataflow_ProjectsJobsWorkItems_Resource Class Reference

The "workItems" collection of methods. More...

Inheritance diagram for Google_Service_Dataflow_ProjectsJobsWorkItems_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 lease ($projectId, $jobId, Google_Service_Dataflow_LeaseWorkItemRequest $postBody, $optParams=array())
 Leases a dataflow WorkItem to run.
 
 reportStatus ($projectId, $jobId, Google_Service_Dataflow_ReportWorkItemStatusRequest $postBody, $optParams=array())
 Reports the status of dataflow WorkItems leased by a worker.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "workItems" collection of methods.

Typical usage is: $dataflowService = new Google_Service_Dataflow(...); $workItems = $dataflowService->workItems;

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

◆ lease()

Google_Service_Dataflow_ProjectsJobsWorkItems_Resource::lease ( $projectId,
$jobId,
Google_Service_Dataflow_LeaseWorkItemRequest $postBody,
$optParams = array() )

Leases a dataflow WorkItem to run.

(workItems.lease)

Parameters
string$projectIdIdentifies the project this worker belongs to.
string$jobIdIdentifies the workflow job this worker belongs to.
Google_LeaseWorkItemRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dataflow_LeaseWorkItemResponse

◆ reportStatus()

Google_Service_Dataflow_ProjectsJobsWorkItems_Resource::reportStatus ( $projectId,
$jobId,
Google_Service_Dataflow_ReportWorkItemStatusRequest $postBody,
$optParams = array() )

Reports the status of dataflow WorkItems leased by a worker.

(workItems.reportStatus)

Parameters
string$projectIdThe project which owns the WorkItem's job.
string$jobIdThe job which the WorkItem is part of.
Google_ReportWorkItemStatusRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Dataflow_ReportWorkItemStatusResponse

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