BatchTaskEnvironment

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-batch-task-environment-schema.json",
  "title": "BatchTaskEnvironment",
  "description": "A batch task environment resource defines the software that is used to execute tasks.\nIt mainly contains a URL to a container image along with other configurations that are needed by the image.\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/BatchTaskEnvironment",
  "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": "The batch task environment description.",
      "maxLength": 400,
      "type": "string"
    },
    "displayName": {
      "description": "A user-friendly name. Does not have to be unique, and it's changeable.\nIf not specified or provided as null or empty string, it be generated as \"<resourceType><timeCreated>\", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623.\n",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "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 task environment.",
      "type": "string"
    },
    "imageUrl": {
      "description": "The URL of the ocir image.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "lifecycleState": {
      "description": "The current state of the batch task environment.\n",
      "enum": [
        "ACTIVE",
        "DELETED"
      ],
      "type": "string"
    },
    "securityContext": {
      "$ref": "#/$defs/SecurityContext"
    },
    "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 task environment 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 task environment 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"
    },
    "volumes": {
      "description": "List of volumes attached to the image.\nThe use cases of the volumes are but not limited to: read the input of the task and write the output.\n",
      "items": {
        "$ref": "#/$defs/BatchTaskEnvironmentVolume"
      },
      "maxItems": 10,
      "type": "array",
      "x-extra-annotations": "@jakarta.validation.constraints.Size(max = 10)"
    },
    "workingDirectory": {
      "description": "Container's working directory.",
      "maxLength": 1024,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "id",
    "compartmentId",
    "displayName",
    "imageUrl",
    "volumes",
    "lifecycleState",
    "timeCreated",
    "freeformTags",
    "definedTags",
    "systemTags"
  ],
  "type": "object",
  "$defs": {
    "BatchTaskEnvironmentVolume": {
      "description": "A base type for volume for batch task environment.",
      "properties": {
        "type": {
          "description": "Discriminator for sub-entities.",
          "enum": [
            "NFS"
          ],
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "type": "object"
    },
    "SecurityContext": {
      "description": "Security context for container runtime configuration.\n\nSee also [docs](https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/datatypes/LinuxSecurityContext).\n",
      "properties": {
        "fsGroup": {
          "description": "A special supplemental group ID that applies to all containers in a pod.",
          "type": "integer"
        },
        "runAsGroup": {
          "description": "Group ID for running processes inside the container.",
          "type": "integer"
        },
        "runAsUser": {
          "description": "User ID for running processes inside the container.",
          "type": "integer"
        }
      }
    }
  }
}