# EventRecord

A streaming event record. Records are newline-separated as per the chunked output standard. Each record will contain a 'state' field and potentially a 'data' field. When the state is 'RUNNING', the 'data' field will be valid. In all other states, the 'data' field will be null.

**Type**: `object`

## Properties

- name: data (optional)
  type: `ReadableData`

- name: heartbeatToken (optional)
  type: string
  description: The token that should be used by the client to send a heartbeat back to the server. This will usually only be set for the 'HEARTBEAT' state. Heartbeats back from the client are only required when heartbeatToken is not null.

- name: jobState (required)
  type: enum: `HEARTBEAT`, `RUNNING`, `FAILED`, `FINISHED`, `CANCELLED`, `TIMED_OUT`, `UNKNOWN`, `SCANNED_MAX`, `QUERY_TOO_LARGE`
  description: The state of the job at the time of the record. Also indicates validity of the data field.
