Documentation

Google_Service_Dataflow_Resource_ProjectsLocationsJobsWorkItems extends Google_Service_Resource
in package

The "workItems" collection of methods.

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

Table of Contents

$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.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
lease()  : Google_Service_Dataflow_LeaseWorkItemResponse
Leases a dataflow WorkItem to run. (workItems.lease)
reportStatus()  : Google_Service_Dataflow_ReportWorkItemStatusResponse
Reports the status of dataflow WorkItems leased by a worker.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__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
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

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>
Tags
static
Return values
string —

$requestUrl

lease()

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

public lease(string $projectId, string $location, string $jobId, Google_Service_Dataflow_LeaseWorkItemRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataflow_LeaseWorkItemResponse
Parameters
$projectId : string

Identifies the project this worker belongs to.

$location : string

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

$jobId : string

Identifies the workflow job this worker belongs to.

$postBody : Google_Service_Dataflow_LeaseWorkItemRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dataflow_LeaseWorkItemResponse —

reportStatus()

Reports the status of dataflow WorkItems leased by a worker.

public reportStatus(string $projectId, string $location, string $jobId, Google_Service_Dataflow_ReportWorkItemStatusRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataflow_ReportWorkItemStatusResponse

(workItems.reportStatus)

Parameters
$projectId : string

The project which owns the WorkItem's job.

$location : string

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

$jobId : string

The job which the WorkItem is part of.

$postBody : Google_Service_Dataflow_ReportWorkItemStatusRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Dataflow_ReportWorkItemStatusResponse —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results