Keboola · Schema

Job

Data PlatformETLELTData PipelinesData StorageTransformationsOrchestrationData OperationsCloud DataSnowflakeBigQuery

Properties

Name	Type	Description
id	string
runId	string	Run ID is same as Job ID, unless the job is a child job. A child job is created by providing the parent Run ID in the X-KBC-RunId parameter. The runId of a child job contains the parent runId and the
branchId	string	Jobs from the main branch will have branchId = null
project	object
token	object
status	object
desiredStatus	string
component	string
mode	string
tag	string
config	string
configRow	string
configData	object
result	object
createdTime	string
startTime	string
endTime	string
delayedStartTime	string	Delayed start time - the earliest time when the job can be started
durationSeconds	integer
isFinished	boolean
url	string
variableValuesId	string
variableValuesData	object
backend	object
metrics	object
type	object
orchestrationTaskId	string
previousJobId	string
onlyOrchestrationTaskIds	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Job",
  "type": "object",
  "required": [
    "id",
    "runId",
    "project",
    "token",
    "status",
    "mode",
    "component",
    "createdTime",
    "isFinished",
    "url"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "123456789"
    },
    "runId": {
      "type": "string",
      "example": "123456790.123456789",
      "description": "Run ID is same as Job ID, unless the job is a child job. A child\njob is created by providing the parent Run ID in the X-KBC-RunId\nparameter. The runId of a child job contains the parent runId and\nthe child job ID separated by dot. The nesting depth is not limited.\nA parent-child job relationship means that e.g. when a parent job is terminated\nit's child jobs are terminated too. The parent-child job relationship\ndoes not mean that the parent will wait for it's children to finish.\n"
    },
    "branchId": {
      "type": "string",
      "example": "123456789",
      "description": "Jobs from the main branch will have branchId = null\n"
    },
    "project": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": 123
        }
      }
    },
    "token": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": 12345
        },
        "description": {
          "type": "string",
          "example": "[email protected]"
        }
      }
    },
    "status": {
      "$ref": "#/components/schemas/JobStatus"
    },
    "desiredStatus": {
      "type": "string",
      "nullable": true,
      "enum": [
        "processing",
        "terminating"
      ]
    },
    "component": {
      "type": "string",
      "example": "keboola.ex-db-snowflake"
    },
    "mode": {
      "type": "string",
      "enum": [
        "run",
        "debug"
      ]
    },
    "tag": {
      "type": "string",
      "nullable": true,
      "example": "1.2.3"
    },
    "config": {
      "type": "string",
      "nullable": true,
      "example": "123456789"
    },
    "configRow": {
      "type": "string",
      "nullable": true,
      "example": "123456789"
    },
    "configData": {
      "type": "object",
      "nullable": true,
      "example": {
        "parameters": {
          "foo": "bar",
          "baz": "mek"
        }
      }
    },
    "result": {
      "type": "object",
      "nullable": true,
      "properties": {
        "images": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "digests": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "id": {
                "type": "string"
              }
            }
          }
        },
        "configVersion": {
          "type": "integer"
        },
        "message": {
          "type": "string"
        }
      }
    },
    "createdTime": {
      "type": "string",
      "format": "date-time",
      "example": "2019-06-21T09:12:33.001Z"
    },
    "startTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "example": "2019-06-21T09:12:33.001Z"
    },
    "endTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "example": "2019-06-21T09:12:33.001Z"
    },
    "delayedStartTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "example": "2019-06-21T09:12:33.001Z",
      "description": "Delayed start time - the earliest time when the job can be started"
    },
    "durationSeconds": {
      "type": "integer",
      "nullable": true,
      "example": 165
    },
    "isFinished": {
      "type": "boolean",
      "example": false
    },
    "url": {
      "type": "string",
      "example": "https://queue.east-us-2.azure.keboola-testing.com/jobs/123456789"
    },
    "variableValuesId": {
      "type": "string",
      "nullable": true,
      "example": "1234"
    },
    "variableValuesData": {
      "type": "object",
      "nullable": true,
      "properties": {
        "values": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            }
          }
        }
      },
      "example": {
        "items": [
          {
            "name": "testVariable",
            "value": "testValue"
          }
        ]
      }
    },
    "backend": {
      "type": "object",
      "nullable": true,
      "properties": {
        "type": {
          "type": "string"
        },
        "containerType": {
          "type": "string"
        },
        "context": {
          "type": "string"
        }
      },
      "example": {
        "type": "small",
        "context": "123_extractor"
      }
    },
    "metrics": {
      "type": "object",
      "nullable": true,
      "properties": {
        "storage": {
          "type": "object",
          "properties": {
            "inputTablesBytesSum": {
              "type": "integer"
            },
            "outputTablesBytesSum": {
              "type": "integer"
            }
          }
        },
        "backend": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string"
            },
            "containerType": {
              "type": "string"
            },
            "context": {
              "type": "string"
            }
          },
          "example": {
            "type": "small",
            "context": "123_extractor"
          }
        }
      }
    },
    "type": {
      "$ref": "#/components/schemas/JobType"
    },
    "orchestrationTaskId": {
      "type": "string",
      "nullable": true,
      "minLength": 1
    },
    "previousJobId": {
      "type": "string",
      "nullable": true,
      "minLength": 1
    },
    "onlyOrchestrationTaskIds": {
      "type": "array",
      "nullable": true,
      "minItems": 1,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "nullable": false,
        "minLength": 1
      }
    }
  }
}