GOgoogle
projects

POST /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease

Changed on

Leases a dataflow WorkItem to run.

Request

  • Base URL
    https://dataflow.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/cloud-platform
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/compute
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/compute
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdstring required

Identifies the project this worker belongs to.

locationstring required

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

jobIdstring required

Identifies the workflow job this worker belongs to.

Request body

currentWorkerTimestring google-datetime

The current timestamp at the worker.

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.

requestedLeaseDurationstring google-duration

The initial lease period.

unifiedWorkerRequestobject

Untranslated bag-of-bytes WorkRequest from UnifiedWorker.

workItemTypesstring[]

Filter for WorkItem type.

workerCapabilitiesstring[]

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

workerIdstring

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

Response

Successful response

unifiedWorkerResponseobject

Untranslated bag-of-bytes WorkResponse for UnifiedWorker.

Changes

  • 69a3fb1fef85Revision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2c

  • e94d44227b2eRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2c