Apache Livy · JSON Structure

Rest Api Create Batch Request Structure

Parameters for creating a batch Spark job

Type: object Properties: 10 Required: 1
Big DataInteractive ComputingOpen SourceRESTSpark

CreateBatchRequest is a JSON Structure definition published by Apache Livy, describing 10 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

file proxyUser className args jars pyFiles driverMemory executorMemory numExecutors conf

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "type": "object",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-livy/refs/heads/main/json-structure/rest-api-create-batch-request-structure.json",
  "name": "CreateBatchRequest",
  "description": "Parameters for creating a batch Spark job",
  "properties": {
    "file": {
      "type": "string",
      "description": "File to execute",
      "example": "s3://my-bucket/jobs/my-spark-job.py"
    },
    "proxyUser": {
      "type": "string",
      "description": "User to impersonate",
      "example": "alice"
    },
    "className": {
      "type": "string",
      "description": "Application Java/Spark main class",
      "example": "com.example.MySparkJob"
    },
    "args": {
      "type": "array",
      "description": "Command line arguments",
      "items": {
        "type": "string"
      }
    },
    "jars": {
      "type": "array",
      "description": "JARs to include",
      "items": {
        "type": "string"
      }
    },
    "pyFiles": {
      "type": "array",
      "description": "Python files",
      "items": {
        "type": "string"
      }
    },
    "driverMemory": {
      "type": "string",
      "description": "Driver memory",
      "example": "512m"
    },
    "executorMemory": {
      "type": "string",
      "description": "Executor memory",
      "example": "1g"
    },
    "numExecutors": {
      "type": "integer",
      "description": "Number of executors",
      "example": 4
    },
    "conf": {
      "type": "object",
      "description": "Spark configuration"
    }
  },
  "required": [
    "file"
  ]
}