BatchContext

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-batch-context-schema.json",
  "title": "BatchContext",
  "description": "Representation of a batch context and its configurations.\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/BatchContext",
  "properties": {
    "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": "Summarized information about the batch context.",
      "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"
    },
    "entitlements": {
      "additionalProperties": {
        "description": "Value of the limit.",
        "minimum": 0,
        "type": "integer"
      },
      "description": "Mapping of concurrent/shared resources used in job tasks to their limits.",
      "maxProperties": 100,
      "type": "object",
      "x-extra-annotations": "@jakarta.validation.constraints.Size(max = 100)"
    },
    "fleets": {
      "description": "List of fleet configurations related to the batch context.",
      "items": {
        "$ref": "#/$defs/Fleet"
      },
      "maxItems": 5,
      "minItems": 1,
      "type": "array"
    },
    "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 context.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "jobPriorityConfigurations": {
      "description": "List of job priority configurations related to the batch context.",
      "items": {
        "$ref": "#/$defs/JobPriorityConfiguration"
      },
      "maxItems": 10,
      "type": "array",
      "x-extra-annotations": "@jakarta.validation.constraints.Size(max = 10)"
    },
    "lifecycleDetails": {
      "description": "A message that describes the current state in more detail. For example, can 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 context.\n",
      "enum": [
        "CREATING",
        "ACTIVE",
        "INACTIVE",
        "UPDATING",
        "NEEDS_ATTENTION",
        "DELETING",
        "DELETED",
        "FAILED"
      ],
      "type": "string"
    },
    "loggingConfiguration": {
      "$ref": "#/$defs/LoggingConfiguration"
    },
    "network": {
      "$ref": "#/$defs/Network"
    },
    "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 context 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 context 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",
    "displayName",
    "lifecycleState",
    "timeCreated",
    "freeformTags",
    "definedTags",
    "systemTags",
    "network",
    "fleets",
    "jobPriorityConfigurations",
    "entitlements"
  ],
  "type": "object",
  "$defs": {
    "Fleet": {
      "description": "Fleet configuration of the batch context.",
      "properties": {
        "type": {
          "description": "Type of the fleet. Also serves as a discriminator for sub-entities.",
          "enum": [
            "SERVICE_MANAGED_FLEET",
            "SERVICE_MANAGED_GPU_FLEET"
          ],
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "type": "object"
    },
    "JobPriorityConfiguration": {
      "description": "Job priority configuration to instruct the service on how to use priority tags.",
      "properties": {
        "tagKey": {
          "description": "Name of the tag key.",
          "maxLength": 100,
          "minLength": 1,
          "type": "string"
        },
        "tagNamespace": {
          "description": "Name of the corresponding tag namespace.",
          "maxLength": 100,
          "minLength": 1,
          "type": "string"
        },
        "values": {
          "additionalProperties": {
            "description": "Priority value as an integer.",
            "type": "integer"
          },
          "description": "Mapping of tag value to its priority.",
          "maxProperties": 10,
          "minProperties": 1,
          "type": "object",
          "x-extra-annotations": "@jakarta.validation.constraints.Size(min = 1, max = 10)"
        },
        "weight": {
          "description": "Weight associated with the tag key. Percentage point is the unit of measurement.",
          "maximum": 100,
          "minimum": -100,
          "type": "integer"
        }
      },
      "required": [
        "tagNamespace",
        "tagKey",
        "weight",
        "values"
      ],
      "type": "object"
    },
    "LoggingConfiguration": {
      "description": "Logging configuration of the batch context.",
      "properties": {
        "type": {
          "description": "Type of the logging configuration. Discriminator for sub-entities.",
          "enum": [
            "OCI_LOGGING"
          ],
          "type": "string"
        }
      },
      "required": [
        "type"
      ]
    },
    "Network": {
      "description": "Network configuration of the batch context.",
      "properties": {
        "nsgIds": {
          "description": "A list of [OCIDs](/iaas/Content/General/Concepts/identifiers.htm) of associated network security groups.\n",
          "items": {
            "maxLength": 255,
            "minLength": 1,
            "type": "string"
          },
          "maxItems": 10,
          "type": "array",
          "uniqueItems": true,
          "x-extra-annotations": "@jakarta.validation.constraints.Size(max = 10) @io.micronaut.validation.annotation.UniqueElements"
        },
        "subnetId": {
          "description": "[OCID](/iaas/Content/General/Concepts/identifiers.htm) of associated subnet.\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "vnics": {
          "description": "A list of private endpoint's VNICs.\n",
          "items": {
            "$ref": "#/$defs/Vnic"
          },
          "maxItems": 10,
          "type": "array"
        }
      },
      "required": [
        "subnetId",
        "nsgIds",
        "vnics"
      ],
      "type": "object"
    },
    "Vnic": {
      "description": "Private endpoint's VNIC.",
      "properties": {
        "id": {
          "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint's VNIC,\nwhich resides in the customer's VCN.\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "sourceIps": {
          "description": "A list of private IP addresses (in the customer's VCN) that represent access points for the service.\n",
          "items": {
            "maxLength": 46,
            "minLength": 1,
            "type": "string"
          },
          "maxItems": 10,
          "type": "array"
        }
      },
      "required": [
        "id",
        "sourceIps"
      ],
      "type": "object"
    }
  }
}