aidocument.oracle.com/v1beta1¶

APIVersion: aidocument.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¶

Package	Support	Latest release	Resources
AI Document	preview	`v2.1.0-alpha`	Project

Resources¶

Kind	Scope	Sample	Packages
Project	Namespaced	Sample	AI Document (`v2.1.0-alpha`)

Project¶

Manage OCI AI Document projects.

Plural: projects
Scope: Namespaced
APIVersion: aidocument.oracle.com/v1beta1
Sample: Sample (config/samples/aidocument_v1beta1_project.yaml)
Packages: AI Document (v2.1.0-alpha)

Spec¶

ProjectSpec defines the desired state of Project.

Field	Description	Type	Required	Default	Enum
`compartmentId`	The compartment identifier.	`string`	Yes	-	-
`definedTags`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`description`	An optional description of the project.	`string`	No	-	-
`displayName`	A human-friendly name for the project, that can be changed.	`string`	No	-	-
`freeformTags`	A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-

Status¶

ProjectStatus defines the observed state of Project.

Field	Description	Type	Required	Default	Enum
`compartmentId`	The compartment identifier.	`string`	No	-	-
`definedTags`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}`	`map[string, map[string, string]]`	No	-	-
`description`	An optional description of the project.	`string`	No	-	-
`displayName`	A human-friendly name for the project, which can be changed.	`string`	No	-	-
`freeformTags`	A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}`	`map[string, string]`	No	-	-
`id`	A unique identifier that is immutable after creation.	`string`	No	-	-
`lifecycleDetails`	A message describing the current state in more detail, that can provide actionable information if creation failed.	`string`	No	-	-
`lifecycleState`	The current state of the project.	`string`	No	-	-
`locks`	Locks associated with this resource.	`list[object]`	No	-	-
`status`	-	`object`	Yes	-	-
`systemTags`	Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}`	`map[string, map[string, string]]`	No	-	-
`timeCreated`	When the project was created, as an RFC3339 datetime string.	`string`	No	-	-
`timeUpdated`	When the project was updated, as an RFC3339 datetime string.	`string`	No	-	-

Status.locks[]¶

Back to Project status

ProjectLock defines nested fields for Project.Lock.

Field	Description	Type	Required	Default	Enum
`compartmentId`	The lock compartment ID.	`string`	No	-	-
`message`	A message added by the lock creator. The message typically gives an indication of why the resource is locked.	`string`	No	-	-
`relatedResourceId`	The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.	`string`	No	-	-
`timeCreated`	Indicates when the lock was created, in the format defined by RFC 3339.	`string`	No	-	-
`type`	Lock type.	`string`	No	-	-

Status.status¶

Back to Project 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 Project 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 Project 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 Project status

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