BatchJob

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-batch-job-schema.json",
  "title": "BatchJob",
  "description": "A batch job represents the execution unit that is invoked on a batch's pools of compute resources.\nA job is composed of one or more tasks, which are the executable commands.\n\nTo use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to\nan administrator. If you're an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).\n",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-batchcomputing-api-openapi.yml#/components/schemas/BatchJob",
  "properties": {
    "batchContextId": {
      "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the parent batch context of the parent job pool.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "batchJobPoolId": {
      "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the parent batch job pool.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "compartmentId": {
      "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only the String type is supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
        "type": "object"
      },
      "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
      "type": "object"
    },
    "description": {
      "description": "An optional description that provides additional context next to the displayName.",
      "maxLength": 400,
      "type": "string"
    },
    "displayName": {
      "description": "A user-friendly name. Does not have to be unique, and it's changeable.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "environmentVariables": {
      "description": "An environment variables to use for the job's tasks (can be overridden by task's environment variables).",
      "items": {
        "$ref": "#/$defs/EnvironmentVariable"
      },
      "maxItems": 100,
      "type": "array",
      "x-extra-annotations": "@jakarta.validation.constraints.Size(max = 100)"
    },
    "freeformTags": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
      "type": "object"
    },
    "id": {
      "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the batch job.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "lifecycleDetails": {
      "description": "A message that describes the current state of the batch job in more detail. For example,\ncan be used to provide actionable information for a resource in the Failed state.\n",
      "maxLength": 255,
      "type": "string"
    },
    "lifecycleState": {
      "description": "The current state of the batch job.\n",
      "enum": [
        "ACCEPTED",
        "WAITING",
        "IN_PROGRESS",
        "SUCCEEDED",
        "NEEDS_ATTENTION",
        "FAILED",
        "CANCELING",
        "CANCELED"
      ],
      "type": "string"
    },
    "priority": {
      "description": "A value calculated by the system based on the priority tags.",
      "minimum": 0,
      "type": "integer"
    },
    "progressDetails": {
      "description": "A more detailed textual representation of the job completion.",
      "maxLength": 255,
      "type": "string"
    },
    "progressPercentage": {
      "description": "A percentage value (0..100) of the job completion.",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    },
    "systemTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only the String type is supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
        "type": "object"
      },
      "description": "System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
      "type": "object"
    },
    "timeCreated": {
      "description": "The date and time the batch job was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\n\nExample: `2016-08-25T21:10:29.600Z`\n",
      "format": "date-time",
      "type": "string"
    },
    "timeUpdated": {
      "description": "The date and time the batch job was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\n\nExample: `2016-08-25T21:10:29.600Z`\n",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "id",
    "compartmentId",
    "batchJobPoolId",
    "batchContextId",
    "displayName",
    "timeCreated",
    "lifecycleState",
    "freeformTags",
    "definedTags",
    "systemTags"
  ],
  "type": "object",
  "$defs": {
    "EnvironmentVariable": {
      "description": "OS environment variable.",
      "properties": {
        "name": {
          "description": "The name of the environment variable.",
          "maxLength": 255,
          "minLength": 1,
          "pattern": "^[-._a-zA-Z][-._a-zA-Z0-9]*$",
          "type": "string"
        },
        "value": {
          "description": "The value of the environment variable.",
          "maxLength": 2048,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "name",
        "value"
      ],
      "type": "object"
    }
  }
}