oci-service-operator

generativeaidata.oracle.com/v1beta1

Back to API Reference

APIVersion: generativeaidata.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

No customer-visible package currently exposes generativeaidata.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
EnrichmentJob Namespaced Sample -

EnrichmentJob

Manage OCI Generative AI Data enrichment jobs.

Spec

EnrichmentJobSpec defines the desired state of EnrichmentJob.

Field Description Type Required Default Enum
compartmentId The compartment OCID used only for exact ListEnrichmentJobs lookup before a new job is generated. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description An optional description of the EnrichmentJob. string No - -
displayName A user-friendly display name. It does not have to be unique and can be modified. Avoid entering confidential information. string No - -
enrichmentJobConfiguration EnrichmentJobConfiguration defines nested fields for EnrichmentJob.EnrichmentJobConfiguration. object Yes - -
enrichmentJobType 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). string Yes - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
semanticStoreId The OCID of the semantic store that scopes GenerateEnrichmentJob, GetEnrichmentJob, and CancelEnrichmentJob. string Yes - -

Spec.enrichmentJobConfiguration

Back to EnrichmentJob spec

EnrichmentJobConfiguration defines nested fields for EnrichmentJob.EnrichmentJobConfiguration.

Field Description Type Required Default Enum
databaseObjects Collection of the DatabaseObjects to be enriched for the given schema. list[object] No - -
deltaRefreshSchedule Schedule for occurrences of Delta Refresh jobs Unknown nested fields are preserved. object (preserves unknown fields) No - -
enrichmentJobType - string No - -
jsonData - string No - -
schemaName Name of the DB Schema to be enriched string No - -

Spec.enrichmentJobConfiguration.databaseObjects[]

Back to EnrichmentJob spec

EnrichmentJobConfigurationDatabaseObject defines nested fields for EnrichmentJob.EnrichmentJobConfiguration.DatabaseObject.

Field Description Type Required Default Enum
description An optional description of the DatabaseObject. string No - -
name The fully qualified name of the database object. string Yes - -
type The type of the database object (e.g., table, view, procedure). string Yes - -

Status

EnrichmentJobStatus defines the observed state of EnrichmentJob.

Field Description Type Required Default Enum
compartmentId The bound compartment ID carried forward for exact ListEnrichmentJobs lookup and create-only drift validation. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description An optional description of the EnrichmentJob. string No - -
displayName A user-friendly display name. It does not have to be unique and can be modified. Avoid entering confidential information. string No - -
enrichmentJobConfiguration EnrichmentJobConfiguration defines nested fields for EnrichmentJob.EnrichmentJobConfiguration. object No - -
enrichmentJobType 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). string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
id Unique identifier that is immutable on creation. string No - -
lifecycleDetails A message describing the current state in more detail that can provide actionable information. string No - -
lifecycleState The lifecycleState of GenerateSqlJob. string No - -
percentComplete The percentage of the enrichment job that has been completed. number No - -
semanticStoreId Owning SemanticStore OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for an EnrichmentJob. string No - -
status - object Yes - -
systemTags System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeAccepted The date and time that the enrichment job was accepted in the format of an RFC3339 datetime string. string No - -
timeFinished The date and time that the enrichment job was finished in the format of an RFC3339 datetime string. string No - -
timeStarted The date and time that the enrichment job was started in the format of an RFC3339 datetime string. string No - -

Status.enrichmentJobConfiguration

Back to EnrichmentJob status

EnrichmentJobConfiguration defines nested fields for EnrichmentJob.EnrichmentJobConfiguration.

Field Description Type Required Default Enum
databaseObjects Collection of the DatabaseObjects to be enriched for the given schema. list[object] No - -
deltaRefreshSchedule Schedule for occurrences of Delta Refresh jobs Unknown nested fields are preserved. object (preserves unknown fields) No - -
enrichmentJobType - string No - -
jsonData - string No - -
schemaName Name of the DB Schema to be enriched string No - -

Status.enrichmentJobConfiguration.databaseObjects[]

Back to EnrichmentJob status

EnrichmentJobConfigurationDatabaseObject defines nested fields for EnrichmentJob.EnrichmentJobConfiguration.DatabaseObject.

Field Description Type Required Default Enum
description An optional description of the DatabaseObject. string No - -
name The fully qualified name of the database object. string Yes - -
type The type of the database object (e.g., table, view, procedure). string Yes - -

Status.status

Back to EnrichmentJob status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to EnrichmentJob status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to EnrichmentJob status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to EnrichmentJob status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -