StreamGroup

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-stream-group-schema.json",
  "title": "StreamGroup",
  "description": "Details for a Stream Group",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-aiservicevision-api-openapi.yml#/components/schemas/StreamGroup",
  "properties": {
    "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": "A human-friendly name for the streamGroup.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "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 streamGroup.\n",
      "type": "string"
    },
    "isEnabled": {
      "description": "Stream",
      "type": "boolean"
    },
    "lifecycleState": {
      "description": "The current state of the streamGroup.",
      "enum": [
        "CREATING",
        "UPDATING",
        "ACTIVE",
        "DELETING",
        "DELETED",
        "FAILED"
      ],
      "type": "string"
    },
    "streamOverlaps": {
      "description": "List of streamSource OCIDs where the streamSource overlaps in field of view.",
      "items": {
        "$ref": "#/$defs/StreamGroupOverlap"
      },
      "type": "array"
    },
    "streamSourceIds": {
      "description": "List of streamSource OCIDs associated with the stream group",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "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 streamGroup was created, as an RFC3339 datetime string.",
      "format": "date-time",
      "type": "string"
    },
    "timeUpdated": {
      "description": "When the streamGroup was updated, as an RFC3339 datetime string.",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "id",
    "compartmentId"
  ],
  "type": "object",
  "$defs": {
    "StreamGroupOverlap": {
      "description": "List of streamSource OCIDs that have overlapping fields of view",
      "properties": {
        "overlappingStreams": {
          "description": "List of streamSource OCIDs.",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "type": "object"
    }
  }
}