EnrichmentJob

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/oracle/json-schema/oracle-enrichment-job-schema.json",
  "title": "EnrichmentJob",
  "description": "Object representing to EnrichmentJob.\nocidEntityType: generativeaiEnrichmentJob\nadLocality: regional\n",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-cancelenrichmentjob-api-openapi.yml#/components/schemas/EnrichmentJob",
  "properties": {
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "type": "object"
        },
        "type": "object"
      },
      "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
      "type": "object"
    },
    "description": {
      "description": "An optional description of the EnrichmentJob.",
      "maxLength": 400,
      "minLength": 1,
      "type": "string",
      "x-default-description": "null"
    },
    "displayName": {
      "description": "A user-friendly display name. It does not have to be unique and can be modified. Avoid entering confidential information.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "enrichmentJobConfiguration": {
      "$ref": "#/$defs/EnrichmentJobConfiguration"
    },
    "enrichmentJobType": {
      "description": "Enrichment job type. Currently supported Full Build (All supported objects in a given schema) and Partial Build (Selected tables and/or supported objects in a given schema).",
      "enum": [
        "FULL_BUILD",
        "PARTIAL_BUILD",
        "DELTA_REFRESH"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/EnrichmentJobType"
    },
    "freeformTags": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
      "type": "object"
    },
    "id": {
      "description": "Unique identifier that is immutable on creation.",
      "type": "string"
    },
    "lifecycleDetails": {
      "description": "A message describing the current state in more detail that can provide actionable information.",
      "type": "string"
    },
    "lifecycleState": {
      "description": "The lifecycleState of GenerateSqlJob.",
      "enum": [
        "ACCEPTED",
        "IN_PROGRESS",
        "FAILED",
        "SUCCEEDED",
        "CANCELING",
        "CANCELED"
      ],
      "type": "string",
      "x-obmcs-top-level-enum": "#/definitions/LifecycleState"
    },
    "percentComplete": {
      "description": "The percentage of the enrichment job that has been completed.",
      "format": "float",
      "maximum": 100,
      "minimum": 0,
      "type": "number"
    },
    "semanticStoreId": {
      "description": "Owning SemanticStore [OCID](/iaas/Content/General/Concepts/identifiers.htm) for an EnrichmentJob.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "systemTags": {
      "additionalProperties": {
        "additionalProperties": {
          "type": "object"
        },
        "type": "object"
      },
      "description": "System tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
      "type": "object"
    },
    "timeAccepted": {
      "description": "The date and time that the enrichment job was accepted in the format of an RFC3339 datetime string.",
      "format": "date-time",
      "type": "string"
    },
    "timeFinished": {
      "description": "The date and time that the enrichment job was finished in the format of an RFC3339 datetime string.",
      "format": "date-time",
      "type": "string"
    },
    "timeStarted": {
      "description": "The date and time that the enrichment job was started in the format of an RFC3339 datetime string.",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "id",
    "semanticStoreId",
    "enrichmentJobType",
    "enrichmentJobConfiguration",
    "timeAccepted",
    "lifecycleDetails",
    "lifecycleState"
  ],
  "type": "object",
  "$defs": {
    "EnrichmentJobConfiguration": {
      "description": "An EnrichmentJobConfiguration describes the database objects that will be targeted by an EnrichmentJob, as described by the job's type.\n",
      "properties": {
        "enrichmentJobType": {
          "description": "Enrichment job type",
          "enum": [
            "FULL_BUILD",
            "PARTIAL_BUILD",
            "DELTA_REFRESH"
          ],
          "type": "string",
          "x-obmcs-top-level-enum": "#/definitions/EnrichmentJobType"
        }
      },
      "required": [
        "enrichmentJobType"
      ],
      "type": "object"
    }
  }
}