datalabelingservice.oracle.com/v1beta1¶
APIVersion: datalabelingservice.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 datalabelingservice.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| Dataset | Namespaced | Sample | - |
Dataset¶
Manage OCI Data Labeling datasets.
Plural:datasetsScope:NamespacedAPIVersion:datalabelingservice.oracle.com/v1beta1Sample: Sample (config/samples/datalabelingservice_v1beta1_dataset.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
DatasetSpec defines the desired state of Dataset.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
annotationFormat |
The annotation format name required for labeling records. | string |
Yes | - | - |
compartmentId |
The OCID of the compartment of the resource. | string |
Yes | - | - |
datasetFormatDetails |
DatasetCreateFormatDetails defines the supported create-time dataset format shape for the published Dataset runtime. | object |
Yes | - | - |
datasetSourceDetails |
DatasetCreateSourceDetails defines the supported create-time source shape for the published Dataset runtime. | object |
Yes | - | - |
definedTags |
The 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 |
A user provided description of the dataset | string |
No | - | - |
displayName |
A user-friendly display name for the resource. | 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 | - | - |
initialImportDatasetConfiguration |
DatasetCreateInitialImportDatasetConfiguration defines the supported create-time import configuration shape for the published Dataset runtime. | object |
No | - | - |
initialRecordGenerationConfiguration |
DatasetInitialRecordGenerationConfiguration defines nested fields for Dataset.InitialRecordGenerationConfiguration. | object |
No | - | - |
labelSet |
DatasetLabelSet defines nested fields for Dataset.LabelSet. | object |
Yes | - | - |
labelingInstructions |
The labeling instructions for human labelers in rich text format | string |
No | - | - |
Spec.datasetFormatDetails¶
DatasetCreateFormatDetails defines the supported create-time dataset format shape for the published Dataset runtime.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
formatType |
FormatType selects the supported published dataset format variant. | string |
Yes | - | DOCUMENT, IMAGE, TEXT |
textFileTypeMetadata |
TextFileTypeMetadata must be set when FormatType is TEXT. | object |
No | - | - |
Spec.datasetFormatDetails.textFileTypeMetadata¶
TextFileTypeMetadata must be set when FormatType is TEXT.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
columnDelimiter |
A column delimiter | string |
No | - | - |
columnIndex |
The index of a selected column. This is a zero-based index. | integer |
Yes | - | - |
columnName |
The name of a selected column. | string |
No | - | - |
escapeCharacter |
An escape character. | string |
No | - | - |
formatType |
FormatType must remain DELIMITED for the published Dataset rollout. | string |
Yes | - | DELIMITED |
lineDelimiter |
A line delimiter. | string |
No | - | - |
Spec.datasetSourceDetails¶
DatasetCreateSourceDetails defines the supported create-time source shape for the published Dataset runtime.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucket |
The object storage bucket that contains the dataset data source. | string |
Yes | - | - |
namespace |
The namespace of the bucket that contains the dataset data source. | string |
Yes | - | - |
prefix |
A common path prefix shared by the objects that make up the dataset. | string |
No | - | - |
sourceType |
SourceType must remain OBJECT_STORAGE for the published Dataset rollout. | string |
Yes | - | OBJECT_STORAGE |
Spec.initialImportDatasetConfiguration¶
DatasetCreateInitialImportDatasetConfiguration defines the supported create-time import configuration shape for the published Dataset runtime.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
importFormat |
DatasetInitialImportDatasetConfigurationImportFormat defines nested fields for Dataset.InitialImportDatasetConfiguration.ImportFormat. | object |
Yes | - | - |
importMetadataPath |
DatasetCreateImportMetadataPath defines the supported create-time import metadata path shape for the published Dataset runtime. | object |
Yes | - | - |
Spec.initialImportDatasetConfiguration.importFormat¶
DatasetInitialImportDatasetConfigurationImportFormat defines nested fields for Dataset.InitialImportDatasetConfiguration.ImportFormat.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Name of import format | string |
Yes | - | - |
version |
Version of import format | string |
No | - | - |
Spec.initialImportDatasetConfiguration.importMetadataPath¶
DatasetCreateImportMetadataPath defines the supported create-time import metadata path shape for the published Dataset runtime.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucket |
Bucket name | string |
Yes | - | - |
namespace |
Bucket namespace name | string |
Yes | - | - |
path |
Path for the metadata file. | string |
Yes | - | - |
sourceType |
SourceType must remain OBJECT_STORAGE for the published Dataset rollout. | string |
Yes | - | OBJECT_STORAGE |
Spec.initialRecordGenerationConfiguration¶
DatasetInitialRecordGenerationConfiguration defines nested fields for Dataset.InitialRecordGenerationConfiguration.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
limit |
The maximum number of records to generate. | number |
No | - | - |
Spec.labelSet¶
DatasetLabelSet defines nested fields for Dataset.LabelSet.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
An ordered collection of labels that are unique by name. | list[object] |
No | - | - |
Spec.labelSet.items[]¶
DatasetLabelSetItem defines nested fields for Dataset.LabelSet.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
An unique name for a label within its dataset. | string |
No | - | - |
Status¶
DatasetStatus defines the observed state of Dataset.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
additionalProperties |
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 | - | - |
annotationFormat |
The annotation format name required for labeling records. | string |
No | - | - |
compartmentId |
The OCID of the compartment of the resource. | string |
No | - | - |
datasetFormatDetails |
DatasetFormatDetails defines nested fields for Dataset.DatasetFormatDetails. | object |
No | - | - |
datasetSourceDetails |
DatasetSourceDetails defines nested fields for Dataset.DatasetSourceDetails. | object |
No | - | - |
definedTags |
The 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 |
A user provided description of the dataset | string |
No | - | - |
displayName |
A user-friendly display name for the resource. | 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 |
The OCID of the Dataset. | string |
No | - | - |
initialImportDatasetConfiguration |
DatasetInitialImportDatasetConfiguration defines nested fields for Dataset.InitialImportDatasetConfiguration. | object |
No | - | - |
initialRecordGenerationConfiguration |
DatasetInitialRecordGenerationConfiguration defines nested fields for Dataset.InitialRecordGenerationConfiguration. | object |
No | - | - |
labelSet |
DatasetLabelSet defines nested fields for Dataset.LabelSet. | object |
No | - | - |
labelingInstructions |
The labeling instructions for human labelers in rich text format | string |
No | - | - |
lifecycleDetails |
A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in FAILED or NEEDS_ATTENTION state. | string |
No | - | - |
lifecycleState |
The state of a dataset. CREATING - The dataset is being created. It will transition to ACTIVE when it is ready for labeling. ACTIVE - The dataset is ready for labeling. UPDATING - The dataset is being updated. It and its related resources may be unavailable for other updates until it returns to ACTIVE. NEEDS_ATTENTION - A dataset updation operation has failed due to validation or other errors and needs attention. DELETING - The dataset and its related resources are being deleted. DELETED - The dataset has been deleted and is no longer available. FAILED - The dataset has failed due to validation or other errors. | string |
No | - | - |
lifecycleSubstate |
The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported. | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
The 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 |
The date and time the resource was created, in the timestamp format defined by RFC3339. | string |
No | - | - |
timeUpdated |
The date and time the resource was last updated, in the timestamp format defined by RFC3339. | string |
No | - | - |
Status.datasetFormatDetails¶
DatasetFormatDetails defines nested fields for Dataset.DatasetFormatDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
formatType |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
textFileTypeMetadata |
DatasetFormatDetailsTextFileTypeMetadata defines nested fields for Dataset.DatasetFormatDetails.TextFileTypeMetadata. | object |
No | - | - |
Status.datasetFormatDetails.textFileTypeMetadata¶
DatasetFormatDetailsTextFileTypeMetadata defines nested fields for Dataset.DatasetFormatDetails.TextFileTypeMetadata.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
columnDelimiter |
A column delimiter | string |
No | - | - |
columnIndex |
The index of a selected column. This is a zero-based index. | integer |
No | - | - |
columnName |
The name of a selected column. | string |
No | - | - |
escapeCharacter |
An escape character. | string |
No | - | - |
formatType |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
lineDelimiter |
A line delimiter. | string |
No | - | - |
Status.datasetSourceDetails¶
DatasetSourceDetails defines nested fields for Dataset.DatasetSourceDetails.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucket |
The object storage bucket that contains the dataset data source. | string |
No | - | - |
jsonData |
- | string |
No | - | - |
namespace |
The namespace of the bucket that contains the dataset data source. | string |
No | - | - |
prefix |
A common path prefix shared by the objects that make up the dataset. Except for the CSV file type, records are not generated for the objects whose names exactly match with the prefix. | string |
No | - | - |
sourceType |
- | string |
No | - | - |
Status.initialImportDatasetConfiguration¶
DatasetInitialImportDatasetConfiguration defines nested fields for Dataset.InitialImportDatasetConfiguration.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
importFormat |
DatasetInitialImportDatasetConfigurationImportFormat defines nested fields for Dataset.InitialImportDatasetConfiguration.ImportFormat. | object |
Yes | - | - |
importMetadataPath |
DatasetInitialImportDatasetConfigurationImportMetadataPath defines nested fields for Dataset.InitialImportDatasetConfiguration.ImportMetadataPath. | object |
Yes | - | - |
Status.initialImportDatasetConfiguration.importFormat¶
DatasetInitialImportDatasetConfigurationImportFormat defines nested fields for Dataset.InitialImportDatasetConfiguration.ImportFormat.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Name of import format | string |
Yes | - | - |
version |
Version of import format | string |
No | - | - |
Status.initialImportDatasetConfiguration.importMetadataPath¶
DatasetInitialImportDatasetConfigurationImportMetadataPath defines nested fields for Dataset.InitialImportDatasetConfiguration.ImportMetadataPath.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucket |
Bucket name | string |
No | - | - |
jsonData |
- | string |
No | - | - |
namespace |
Bucket namespace name | string |
No | - | - |
path |
Path for the metadata file. | string |
No | - | - |
sourceType |
- | string |
No | - | - |
Status.initialRecordGenerationConfiguration¶
DatasetInitialRecordGenerationConfiguration defines nested fields for Dataset.InitialRecordGenerationConfiguration.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
limit |
The maximum number of records to generate. | number |
No | - | - |
Status.labelSet¶
DatasetLabelSet defines nested fields for Dataset.LabelSet.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
items |
An ordered collection of labels that are unique by name. | list[object] |
No | - | - |
Status.labelSet.items[]¶
DatasetLabelSetItem defines nested fields for Dataset.LabelSet.Item.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
An unique name for a label within its dataset. | string |
No | - | - |
Status.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¶
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¶
| 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[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |