List

Request the job status

8 variables
16 variables

Request the job status.

To request the status of a job, we recommend using projects.locations.jobs.messages.list with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.messages.list is not recommended, as you can only request the status of jobs that are running in us-central1

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services
  • View and manage your Google Compute Engine resources
  • View your Google Compute Engine resources
  • View your email address

Input

This building block consumes 8 input parameters

  = Parameter name
  = Format

projectId STRING Required

A project id

jobId STRING Required

The job to get messages about

location STRING

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id

endTime ANY

Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available)

pageToken STRING

If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned

startTime ANY

If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages)

pageSize INTEGER

If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results

minimumImportance ENUMERATION

Filter to only get messages with importance >= level

Output

This building block provides 16 output parameters

  = Parameter name
  = Format

jobMessages[] OBJECT

A particular message pertaining to a Dataflow job

jobMessages[].messageText STRING

The text of the message

jobMessages[].messageImportance ENUMERATION

Importance level of the message

jobMessages[].time ANY

The timestamp of the message

jobMessages[].id STRING

Deprecated

nextPageToken STRING

The token to obtain the next page of results if there are more

autoscalingEvents[] OBJECT

A structured message reporting an autoscaling decision made by the Dataflow service

autoscalingEvents[].workerPool STRING

A short and friendly name for the worker pool this event refers to, populated from the value of PoolStageRelation::user_pool_name

autoscalingEvents[].targetNumWorkers INTEGER

The target number of workers the worker pool wants to resize to use

autoscalingEvents[].eventType ENUMERATION

The type of autoscaling event to report

autoscalingEvents[].currentNumWorkers INTEGER

The current number of workers the job has

autoscalingEvents[].time ANY

The time this event was emitted to indicate a new target or current num_workers value

autoscalingEvents[].description OBJECT

A rich message format, including a human readable string, a key for identifying the message, and structured data associated with the message for programmatic consumption

autoscalingEvents[].description.messageKey STRING

Identifier for this message type. Used by external systems to internationalize or personalize message

autoscalingEvents[].description.messageText STRING

Human-readable version of message

autoscalingEvents[].description.parameters[] OBJECT

Structured data associated with this message