ListJobMessagesResponse

Response to a request to list job messages.

JSON representation
{
  "jobMessages": [
    {
      object (JobMessage)
    }
  ],
  "nextPageToken": string,
  "autoscalingEvents": [
    {
      object (AutoscalingEvent)
    }
  ]
}
Fields
jobMessages[]

object (JobMessage)

Messages in ascending timestamp order.

nextPageToken

string

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

autoscalingEvents[]

object (AutoscalingEvent)

Autoscaling events in ascending timestamp order.

JobMessage

A particular message pertaining to a Dataflow job.

JSON representation
{
  "id": string,
  "time": string,
  "messageText": string,
  "messageImportance": enum (JobMessageImportance)
}
Fields
id

string

Deprecated.

time

string (Timestamp format)

The timestamp of the message.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

messageText

string

The text of the message.

messageImportance

enum (JobMessageImportance)

Importance level of the message.

AutoscalingEvent

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

JSON representation
{
  "currentNumWorkers": string,
  "targetNumWorkers": string,
  "eventType": enum (AutoscalingEventType),
  "description": {
    object (StructuredMessage)
  },
  "time": string,
  "workerPool": string
}
Fields
currentNumWorkers

string (int64 format)

The current number of workers the job has.

targetNumWorkers

string (int64 format)

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

eventType

enum (AutoscalingEventType)

The type of autoscaling event to report.

description

object (StructuredMessage)

A message describing why the system decided to adjust the current number of workers, why it failed, or why the system decided to not make any changes to the number of workers.

time

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

workerPool

string

A short and friendly name for the worker pool this event refers to.

AutoscalingEventType

Indicates the type of autoscaling event.

Enums
TYPE_UNKNOWN Default type for the enum. Value should never be returned.
TARGET_NUM_WORKERS_CHANGED The TARGET_NUM_WORKERS_CHANGED type should be used when the target worker pool size has changed at the start of an actuation. An event should always be specified as TARGET_NUM_WORKERS_CHANGED if it reflects a change in the targetNumWorkers.
CURRENT_NUM_WORKERS_CHANGED The CURRENT_NUM_WORKERS_CHANGED type should be used when actual worker pool size has been changed, but the targetNumWorkers has not changed.
ACTUATION_FAILURE The ACTUATION_FAILURE type should be used when we want to report an error to the user indicating why the current number of workers in the pool could not be changed. Displayed in the current status and history widgets.
NO_CHANGE Used when we want to report to the user a reason why we are not currently adjusting the number of workers. Should specify both targetNumWorkers, currentNumWorkers and a decision_message.

StructuredMessage

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.

JSON representation
{
  "messageText": string,
  "messageKey": string,
  "parameters": [
    {
      object (Parameter)
    }
  ]
}
Fields
messageText

string

Human-readable version of message.

messageKey

string

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

parameters[]

object (Parameter)

The structured data associated with this message.

Parameter

Structured data associated with this message.

JSON representation
{
  "key": string,
  "value": value
}
Fields
key

string

Key or name for this parameter.

value

value (Value format)

Value for this parameter.