Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1342194234.5 KB
projects

Leases a dataflow WorkItem to run.

post/v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease

Path parameters

projectIdstring required

Identifies the project this worker belongs to.

jobIdstring required

Identifies the workflow job this worker belongs to.

Request body

workItemTypesstring[]

Filter for WorkItem type.

locationstring

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

projectNumberstring int64

Optional. The project number of the project this worker belongs to.

unifiedWorkerRequestobject

Untranslated bag-of-bytes WorkRequest from UnifiedWorker.

currentWorkerTimestring google-datetime

The current timestamp at the worker.

workerIdstring

Identifies the worker leasing work -- typically the ID of the virtual machine running the worker.

workerCapabilitiesstring[]

Worker capabilities. WorkItems might be limited to workers with specific capabilities.

requestedLeaseDurationstring google-duration

The initial lease period.

Response

Successful response