class ProjectsLocationsJobsWorkItems extends Resource (View source)

The "workItems" collection of methods.

Typical usage is:

 $dataflowService = new Google\Service\Dataflow(...);
 $workItems = $dataflowService->projects_locations_jobs_workItems;

Methods

lease(string $projectId, string $location, string $jobId, LeaseWorkItemRequest $postBody, array $optParams = [])

Leases a dataflow WorkItem to run. (workItems.lease)

reportStatus(string $projectId, string $location, string $jobId, ReportWorkItemStatusRequest $postBody, array $optParams = [])

Reports the status of dataflow WorkItems leased by a worker.

Details

LeaseWorkItemResponse lease(string $projectId, string $location, string $jobId, LeaseWorkItemRequest $postBody, array $optParams = [])

Leases a dataflow WorkItem to run. (workItems.lease)

Parameters

string $projectId

Identifies the project this worker belongs to.

string $location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job.

string $jobId

Identifies the workflow job this worker belongs to.

LeaseWorkItemRequest $postBody
array $optParams

Optional parameters.

Return Value

LeaseWorkItemResponse

Exceptions

Exception

ReportWorkItemStatusResponse reportStatus(string $projectId, string $location, string $jobId, ReportWorkItemStatusRequest $postBody, array $optParams = [])

Reports the status of dataflow WorkItems leased by a worker.

(workItems.reportStatus)

Parameters

string $projectId

The project which owns the WorkItem's job.

string $location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job.

string $jobId

The job which the WorkItem is part of.

ReportWorkItemStatusRequest $postBody
array $optParams

Optional parameters.

Return Value

ReportWorkItemStatusResponse

Exceptions

Exception