Apache Livy · Schema

Batch

A batch Spark job

Big DataInteractive ComputingOpen SourceRESTSpark

Properties

Name	Type	Description
id	integer	Batch identifier
appId	string	Spark application ID
appInfo	object	Spark application information
log	array	Recent log lines
state	string	Batch state

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-livy/refs/heads/main/json-schema/rest-api-batch-schema.json",
  "title": "Batch",
  "description": "A batch Spark job",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Batch identifier",
      "example": 0
    },
    "appId": {
      "type": "string",
      "description": "Spark application ID",
      "example": "application_1234567890_0001"
    },
    "appInfo": {
      "type": "object",
      "description": "Spark application information"
    },
    "log": {
      "type": "array",
      "description": "Recent log lines",
      "items": {
        "type": "string"
      }
    },
    "state": {
      "type": "string",
      "description": "Batch state",
      "enum": [
        "not_started",
        "starting",
        "running",
        "dead",
        "shutting_down",
        "success"
      ],
      "example": "success"
    }
  }
}