StreamJob

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-stream-job-schema.json",
  "title": "StreamJob",
  "description": "Job details for a stream analysis.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-aiservicevision-api-openapi.yml#/components/schemas/StreamJob",
  "properties": {
    "agentParticipantId": {
      "description": "participant id of agent where results need to be sent",
      "type": "string"
    },
    "compartmentId": {
      "description": "[OCID](/Content/General/Concepts/identifiers.htm) of compartment\n",
      "type": "string"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only string, integer, and boolean types are supported.\n",
          "type": "object"
        },
        "description": "A key-value pair representing predefined tags' keys and values scoped to a namespace.\nFor example: `{\"bar-key\": \"value\"}`\n",
        "type": "object"
      },
      "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace.\nFor example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
      "type": "object"
    },
    "displayName": {
      "description": "Stream job display name.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "features": {
      "description": "a list of document analysis features.",
      "items": {
        "$ref": "#/$defs/VideoStreamFeature"
      },
      "maxItems": 1,
      "minItems": 1,
      "type": "array"
    },
    "freeformTags": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.\nFor example: `{\"bar-key\": \"value\"}`\n",
      "type": "object"
    },
    "id": {
      "description": "[OCID](/Content/General/Concepts/identifiers.htm) of the streamJob.\n",
      "type": "string"
    },
    "lifecycleDetails": {
      "description": "Additional details about current state of streamJob",
      "type": "string"
    },
    "lifecycleState": {
      "description": "The current state of the Stream job.",
      "enum": [
        "CREATING",
        "UPDATING",
        "ACTIVE",
        "DELETING",
        "DELETED",
        "FAILED",
        "INACTIVE",
        "NEEDS_ATTENTION"
      ],
      "type": "string"
    },
    "streamOutputLocation": {
      "$ref": "#/$defs/StreamOutputLocation"
    },
    "streamSourceId": {
      "description": "[OCID](/Content/General/Concepts/identifiers.htm) of the streamSource\n",
      "type": "string"
    },
    "systemTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only string, integer, and boolean types are supported.\n",
          "type": "object"
        },
        "description": "A key-value pair representing system tags' keys and values scoped to a namespace.\nFor example: `{\"bar-key\": \"value\"}`\n",
        "type": "object"
      },
      "description": "Usage of system tag keys. These predefined keys are scoped to namespaces.\nFor example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
      "type": "object"
    },
    "timeCreated": {
      "description": "When the streamJob was created, as an RFC3339 datetime string.",
      "format": "date-time",
      "type": "string"
    },
    "timeUpdated": {
      "description": "When the stream job was updated, as an RFC3339 datetime string.",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "id",
    "streamSourceId",
    "features",
    "lifecycleState",
    "timeCreated",
    "compartmentId"
  ],
  "type": "object",
  "$defs": {
    "StreamOutputLocation": {
      "description": "Details about a where results will be Sent",
      "properties": {
        "outputLocationType": {
          "description": "Type of output location\nAllowed values are:\n- OBJECT_STORAGE\n",
          "enum": [
            "OBJECT_STORAGE"
          ],
          "type": "string"
        }
      },
      "required": [
        "outputLocationType"
      ],
      "type": "object"
    },
    "VideoStreamFeature": {
      "description": "Details about a stream video feature request.",
      "properties": {
        "featureType": {
          "description": "The feature of video analysis.\nAllowed values are:\n- OBJECT_TRACKING: Object tracking feature(OT).\n- FACE_DETECTION: Face detection feature(FD).\n- OBJECT_DETECTION: Object detection feature(OD)\n",
          "enum": [
            "OBJECT_TRACKING",
            "FACE_DETECTION",
            "OBJECT_DETECTION"
          ],
          "type": "string"
        }
      },
      "required": [
        "featureType"
      ],
      "type": "object"
    }
  }
}