Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

Dataset

This resource provides the Dataset resource in Oracle Cloud Infrastructure Data Labeling Service service.

Creates a new Dataset.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testDataset = new Oci.DataLabellingService.Dataset("testDataset", new()
    {
        AnnotationFormat = @var.Dataset_annotation_format,
        CompartmentId = @var.Compartment_id,
        DatasetFormatDetails = new Oci.DataLabellingService.Inputs.DatasetDatasetFormatDetailsArgs
        {
            FormatType = @var.Dataset_dataset_format_details_format_type,
            TextFileTypeMetadata = new Oci.DataLabellingService.Inputs.DatasetDatasetFormatDetailsTextFileTypeMetadataArgs
            {
                ColumnIndex = @var.Dataset_dataset_format_details_text_file_type_metadata_column_index,
                FormatType = @var.Dataset_dataset_format_details_text_file_type_metadata_format_type,
                ColumnDelimiter = @var.Dataset_dataset_format_details_text_file_type_metadata_column_delimiter,
                ColumnName = @var.Dataset_dataset_format_details_text_file_type_metadata_column_name,
                EscapeCharacter = @var.Dataset_dataset_format_details_text_file_type_metadata_escape_character,
                LineDelimiter = @var.Dataset_dataset_format_details_text_file_type_metadata_line_delimiter,
            },
        },
        DatasetSourceDetails = new Oci.DataLabellingService.Inputs.DatasetDatasetSourceDetailsArgs
        {
            Bucket = @var.Dataset_dataset_source_details_bucket,
            Namespace = @var.Dataset_dataset_source_details_namespace,
            SourceType = @var.Dataset_dataset_source_details_source_type,
            Prefix = @var.Dataset_dataset_source_details_prefix,
        },
        LabelSet = new Oci.DataLabellingService.Inputs.DatasetLabelSetArgs
        {
            Items = new[]
            {
                new Oci.DataLabellingService.Inputs.DatasetLabelSetItemArgs
                {
                    Name = @var.Dataset_label_set_items_name,
                },
            },
        },
        DefinedTags = @var.Dataset_defined_tags,
        Description = @var.Dataset_description,
        DisplayName = @var.Dataset_display_name,
        FreeformTags = @var.Dataset_freeform_tags,
        InitialRecordGenerationConfiguration = ,
        LabelingInstructions = @var.Dataset_labeling_instructions,
    });

});
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/DataLabellingService"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataLabellingService.NewDataset(ctx, "testDataset", &DataLabellingService.DatasetArgs{
			AnnotationFormat: pulumi.Any(_var.Dataset_annotation_format),
			CompartmentId:    pulumi.Any(_var.Compartment_id),
			DatasetFormatDetails: &datalabellingservice.DatasetDatasetFormatDetailsArgs{
				FormatType: pulumi.Any(_var.Dataset_dataset_format_details_format_type),
				TextFileTypeMetadata: &datalabellingservice.DatasetDatasetFormatDetailsTextFileTypeMetadataArgs{
					ColumnIndex:     pulumi.Any(_var.Dataset_dataset_format_details_text_file_type_metadata_column_index),
					FormatType:      pulumi.Any(_var.Dataset_dataset_format_details_text_file_type_metadata_format_type),
					ColumnDelimiter: pulumi.Any(_var.Dataset_dataset_format_details_text_file_type_metadata_column_delimiter),
					ColumnName:      pulumi.Any(_var.Dataset_dataset_format_details_text_file_type_metadata_column_name),
					EscapeCharacter: pulumi.Any(_var.Dataset_dataset_format_details_text_file_type_metadata_escape_character),
					LineDelimiter:   pulumi.Any(_var.Dataset_dataset_format_details_text_file_type_metadata_line_delimiter),
				},
			},
			DatasetSourceDetails: &datalabellingservice.DatasetDatasetSourceDetailsArgs{
				Bucket:     pulumi.Any(_var.Dataset_dataset_source_details_bucket),
				Namespace:  pulumi.Any(_var.Dataset_dataset_source_details_namespace),
				SourceType: pulumi.Any(_var.Dataset_dataset_source_details_source_type),
				Prefix:     pulumi.Any(_var.Dataset_dataset_source_details_prefix),
			},
			LabelSet: &datalabellingservice.DatasetLabelSetArgs{
				Items: datalabellingservice.DatasetLabelSetItemArray{
					&datalabellingservice.DatasetLabelSetItemArgs{
						Name: pulumi.Any(_var.Dataset_label_set_items_name),
					},
				},
			},
			DefinedTags:                          pulumi.Any(_var.Dataset_defined_tags),
			Description:                          pulumi.Any(_var.Dataset_description),
			DisplayName:                          pulumi.Any(_var.Dataset_display_name),
			FreeformTags:                         pulumi.Any(_var.Dataset_freeform_tags),
			InitialRecordGenerationConfiguration: nil,
			LabelingInstructions:                 pulumi.Any(_var.Dataset_labeling_instructions),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataLabellingService.Dataset;
import com.pulumi.oci.DataLabellingService.DatasetArgs;
import com.pulumi.oci.DataLabellingService.inputs.DatasetDatasetFormatDetailsArgs;
import com.pulumi.oci.DataLabellingService.inputs.DatasetDatasetFormatDetailsTextFileTypeMetadataArgs;
import com.pulumi.oci.DataLabellingService.inputs.DatasetDatasetSourceDetailsArgs;
import com.pulumi.oci.DataLabellingService.inputs.DatasetLabelSetArgs;
import com.pulumi.oci.DataLabellingService.inputs.DatasetInitialRecordGenerationConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testDataset = new Dataset("testDataset", DatasetArgs.builder()        
            .annotationFormat(var_.dataset_annotation_format())
            .compartmentId(var_.compartment_id())
            .datasetFormatDetails(DatasetDatasetFormatDetailsArgs.builder()
                .formatType(var_.dataset_dataset_format_details_format_type())
                .textFileTypeMetadata(DatasetDatasetFormatDetailsTextFileTypeMetadataArgs.builder()
                    .columnIndex(var_.dataset_dataset_format_details_text_file_type_metadata_column_index())
                    .formatType(var_.dataset_dataset_format_details_text_file_type_metadata_format_type())
                    .columnDelimiter(var_.dataset_dataset_format_details_text_file_type_metadata_column_delimiter())
                    .columnName(var_.dataset_dataset_format_details_text_file_type_metadata_column_name())
                    .escapeCharacter(var_.dataset_dataset_format_details_text_file_type_metadata_escape_character())
                    .lineDelimiter(var_.dataset_dataset_format_details_text_file_type_metadata_line_delimiter())
                    .build())
                .build())
            .datasetSourceDetails(DatasetDatasetSourceDetailsArgs.builder()
                .bucket(var_.dataset_dataset_source_details_bucket())
                .namespace(var_.dataset_dataset_source_details_namespace())
                .sourceType(var_.dataset_dataset_source_details_source_type())
                .prefix(var_.dataset_dataset_source_details_prefix())
                .build())
            .labelSet(DatasetLabelSetArgs.builder()
                .items(DatasetLabelSetItemArgs.builder()
                    .name(var_.dataset_label_set_items_name())
                    .build())
                .build())
            .definedTags(var_.dataset_defined_tags())
            .description(var_.dataset_description())
            .displayName(var_.dataset_display_name())
            .freeformTags(var_.dataset_freeform_tags())
            .initialRecordGenerationConfiguration()
            .labelingInstructions(var_.dataset_labeling_instructions())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_dataset = oci.data_labelling_service.Dataset("testDataset",
    annotation_format=var["dataset_annotation_format"],
    compartment_id=var["compartment_id"],
    dataset_format_details=oci.data_labelling_service.DatasetDatasetFormatDetailsArgs(
        format_type=var["dataset_dataset_format_details_format_type"],
        text_file_type_metadata=oci.data_labelling_service.DatasetDatasetFormatDetailsTextFileTypeMetadataArgs(
            column_index=var["dataset_dataset_format_details_text_file_type_metadata_column_index"],
            format_type=var["dataset_dataset_format_details_text_file_type_metadata_format_type"],
            column_delimiter=var["dataset_dataset_format_details_text_file_type_metadata_column_delimiter"],
            column_name=var["dataset_dataset_format_details_text_file_type_metadata_column_name"],
            escape_character=var["dataset_dataset_format_details_text_file_type_metadata_escape_character"],
            line_delimiter=var["dataset_dataset_format_details_text_file_type_metadata_line_delimiter"],
        ),
    ),
    dataset_source_details=oci.data_labelling_service.DatasetDatasetSourceDetailsArgs(
        bucket=var["dataset_dataset_source_details_bucket"],
        namespace=var["dataset_dataset_source_details_namespace"],
        source_type=var["dataset_dataset_source_details_source_type"],
        prefix=var["dataset_dataset_source_details_prefix"],
    ),
    label_set=oci.data_labelling_service.DatasetLabelSetArgs(
        items=[oci.data_labelling_service.DatasetLabelSetItemArgs(
            name=var["dataset_label_set_items_name"],
        )],
    ),
    defined_tags=var["dataset_defined_tags"],
    description=var["dataset_description"],
    display_name=var["dataset_display_name"],
    freeform_tags=var["dataset_freeform_tags"],
    initial_record_generation_configuration=oci.data_labelling_service.DatasetInitialRecordGenerationConfigurationArgs(),
    labeling_instructions=var["dataset_labeling_instructions"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testDataset = new oci.datalabellingservice.Dataset("testDataset", {
    annotationFormat: _var.dataset_annotation_format,
    compartmentId: _var.compartment_id,
    datasetFormatDetails: {
        formatType: _var.dataset_dataset_format_details_format_type,
        textFileTypeMetadata: {
            columnIndex: _var.dataset_dataset_format_details_text_file_type_metadata_column_index,
            formatType: _var.dataset_dataset_format_details_text_file_type_metadata_format_type,
            columnDelimiter: _var.dataset_dataset_format_details_text_file_type_metadata_column_delimiter,
            columnName: _var.dataset_dataset_format_details_text_file_type_metadata_column_name,
            escapeCharacter: _var.dataset_dataset_format_details_text_file_type_metadata_escape_character,
            lineDelimiter: _var.dataset_dataset_format_details_text_file_type_metadata_line_delimiter,
        },
    },
    datasetSourceDetails: {
        bucket: _var.dataset_dataset_source_details_bucket,
        namespace: _var.dataset_dataset_source_details_namespace,
        sourceType: _var.dataset_dataset_source_details_source_type,
        prefix: _var.dataset_dataset_source_details_prefix,
    },
    labelSet: {
        items: [{
            name: _var.dataset_label_set_items_name,
        }],
    },
    definedTags: _var.dataset_defined_tags,
    description: _var.dataset_description,
    displayName: _var.dataset_display_name,
    freeformTags: _var.dataset_freeform_tags,
    initialRecordGenerationConfiguration: {},
    labelingInstructions: _var.dataset_labeling_instructions,
});
resources:
  testDataset:
    type: oci:DataLabellingService:Dataset
    properties:
      #Required
      annotationFormat: ${var.dataset_annotation_format}
      compartmentId: ${var.compartment_id}
      datasetFormatDetails:
        formatType: ${var.dataset_dataset_format_details_format_type}
        textFileTypeMetadata:
          columnIndex: ${var.dataset_dataset_format_details_text_file_type_metadata_column_index}
          formatType: ${var.dataset_dataset_format_details_text_file_type_metadata_format_type}
          columnDelimiter: ${var.dataset_dataset_format_details_text_file_type_metadata_column_delimiter}
          columnName: ${var.dataset_dataset_format_details_text_file_type_metadata_column_name}
          escapeCharacter: ${var.dataset_dataset_format_details_text_file_type_metadata_escape_character}
          lineDelimiter: ${var.dataset_dataset_format_details_text_file_type_metadata_line_delimiter}
      datasetSourceDetails:
        bucket: ${var.dataset_dataset_source_details_bucket}
        namespace: ${var.dataset_dataset_source_details_namespace}
        sourceType: ${var.dataset_dataset_source_details_source_type}
        prefix: ${var.dataset_dataset_source_details_prefix}
      labelSet:
        items:
          - name: ${var.dataset_label_set_items_name}
      #Optional
      definedTags: ${var.dataset_defined_tags}
      description: ${var.dataset_description}
      displayName: ${var.dataset_display_name}
      freeformTags: ${var.dataset_freeform_tags}
      initialRecordGenerationConfiguration: {}
      labelingInstructions: ${var.dataset_labeling_instructions}

Create a Dataset Resource

new Dataset(name: string, args: DatasetArgs, opts?: CustomResourceOptions);
@overload
def Dataset(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            annotation_format: Optional[str] = None,
            compartment_id: Optional[str] = None,
            dataset_format_details: Optional[_datalabellingservice.DatasetDatasetFormatDetailsArgs] = None,
            dataset_source_details: Optional[_datalabellingservice.DatasetDatasetSourceDetailsArgs] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            initial_record_generation_configuration: Optional[_datalabellingservice.DatasetInitialRecordGenerationConfigurationArgs] = None,
            label_set: Optional[_datalabellingservice.DatasetLabelSetArgs] = None,
            labeling_instructions: Optional[str] = None)
@overload
def Dataset(resource_name: str,
            args: DatasetArgs,
            opts: Optional[ResourceOptions] = None)
func NewDataset(ctx *Context, name string, args DatasetArgs, opts ...ResourceOption) (*Dataset, error)
public Dataset(string name, DatasetArgs args, CustomResourceOptions? opts = null)
public Dataset(String name, DatasetArgs args)
public Dataset(String name, DatasetArgs args, CustomResourceOptions options)
type: oci:DataLabellingService:Dataset
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DatasetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DatasetArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DatasetArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DatasetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DatasetArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Dataset Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Dataset resource accepts the following input properties:

AnnotationFormat string

The annotation format name required for labeling records.

CompartmentId string

(Updatable) The OCID of the compartment of the resource.

DatasetFormatDetails DatasetDatasetFormatDetailsArgs

It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.

DatasetSourceDetails DatasetDatasetSourceDetailsArgs

This allows the customer to specify the source of the dataset.

LabelSet DatasetLabelSetArgs

An ordered collection of labels that are unique by name.

DefinedTags Dictionary<string, object>

(Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}

Description string

(Updatable) A user provided description of the dataset

DisplayName string

(Updatable) A user-friendly display name for the resource.

FreeformTags Dictionary<string, object>

(Updatable) 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"}

InitialRecordGenerationConfiguration DatasetInitialRecordGenerationConfigurationArgs

The initial generate records configuration. It generates records from the dataset's source.

LabelingInstructions string

(Updatable) The labeling instructions for human labelers in rich text format

AnnotationFormat string

The annotation format name required for labeling records.

CompartmentId string

(Updatable) The OCID of the compartment of the resource.

DatasetFormatDetails DatasetDatasetFormatDetailsArgs

It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.

DatasetSourceDetails DatasetDatasetSourceDetailsArgs

This allows the customer to specify the source of the dataset.

LabelSet DatasetLabelSetArgs

An ordered collection of labels that are unique by name.

DefinedTags map[string]interface{}

(Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}

Description string

(Updatable) A user provided description of the dataset

DisplayName string

(Updatable) A user-friendly display name for the resource.

FreeformTags map[string]interface{}

(Updatable) 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"}

InitialRecordGenerationConfiguration DatasetInitialRecordGenerationConfigurationArgs

The initial generate records configuration. It generates records from the dataset's source.

LabelingInstructions string

(Updatable) The labeling instructions for human labelers in rich text format

annotationFormat String

The annotation format name required for labeling records.

compartmentId String

(Updatable) The OCID of the compartment of the resource.

datasetFormatDetails DatasetDatasetFormatDetailsArgs

It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.

datasetSourceDetails DatasetDatasetSourceDetailsArgs

This allows the customer to specify the source of the dataset.

labelSet DatasetLabelSetArgs

An ordered collection of labels that are unique by name.

definedTags Map<String,Object>

(Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}

description String

(Updatable) A user provided description of the dataset

displayName String

(Updatable) A user-friendly display name for the resource.

freeformTags Map<String,Object>

(Updatable) 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"}

initialRecordGenerationConfiguration DatasetInitialRecordGenerationConfigurationArgs

The initial generate records configuration. It generates records from the dataset's source.

labelingInstructions String

(Updatable) The labeling instructions for human labelers in rich text format

annotationFormat string

The annotation format name required for labeling records.

compartmentId string

(Updatable) The OCID of the compartment of the resource.

datasetFormatDetails DatasetDatasetFormatDetailsArgs

It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.

datasetSourceDetails DatasetDatasetSourceDetailsArgs

This allows the customer to specify the source of the dataset.

labelSet DatasetLabelSetArgs

An ordered collection of labels that are unique by name.

definedTags {[key: string]: any}

(Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}

description string

(Updatable) A user provided description of the dataset

displayName string

(Updatable) A user-friendly display name for the resource.

freeformTags {[key: string]: any}

(Updatable) 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"}

initialRecordGenerationConfiguration DatasetInitialRecordGenerationConfigurationArgs

The initial generate records configuration. It generates records from the dataset's source.

labelingInstructions string

(Updatable) The labeling instructions for human labelers in rich text format

annotation_format str

The annotation format name required for labeling records.

compartment_id str

(Updatable) The OCID of the compartment of the resource.

dataset_format_details DatasetDatasetFormatDetailsArgs

It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.

dataset_source_details DatasetDatasetSourceDetailsArgs

This allows the customer to specify the source of the dataset.

label_set DatasetLabelSetArgs

An ordered collection of labels that are unique by name.

defined_tags Mapping[str, Any]

(Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}

description str

(Updatable) A user provided description of the dataset

display_name str

(Updatable) A user-friendly display name for the resource.

freeform_tags Mapping[str, Any]

(Updatable) 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"}

initial_record_generation_configuration DatasetInitialRecordGenerationConfigurationArgs

The initial generate records configuration. It generates records from the dataset's source.

labeling_instructions str

(Updatable) The labeling instructions for human labelers in rich text format

annotationFormat String

The annotation format name required for labeling records.

compartmentId String

(Updatable) The OCID of the compartment of the resource.

datasetFormatDetails Property Map

It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.

datasetSourceDetails Property Map

This allows the customer to specify the source of the dataset.

labelSet Property Map

An ordered collection of labels that are unique by name.

definedTags Map<Any>

(Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}

description String

(Updatable) A user provided description of the dataset

displayName String

(Updatable) A user-friendly display name for the resource.

freeformTags Map<Any>

(Updatable) 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"}

initialRecordGenerationConfiguration Property Map

The initial generate records configuration. It generates records from the dataset's source.

labelingInstructions String

(Updatable) The labeling instructions for human labelers in rich text format

Outputs

All input properties are implicitly available as output properties. Additionally, the Dataset resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

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.

State string

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.

TimeCreated string

The date and time the resource was created, in the timestamp format defined by RFC3339.

TimeUpdated string

The date and time the resource was last updated, in the timestamp format defined by RFC3339.

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

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.

State string

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.

TimeCreated string

The date and time the resource was created, in the timestamp format defined by RFC3339.

TimeUpdated string

The date and time the resource was last updated, in the timestamp format defined by RFC3339.

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

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.

state String

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.

timeCreated String

The date and time the resource was created, in the timestamp format defined by RFC3339.

timeUpdated String

The date and time the resource was last updated, in the timestamp format defined by RFC3339.

id string

The provider-assigned unique ID for this managed resource.

lifecycleDetails string

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.

state string

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.

timeCreated string

The date and time the resource was created, in the timestamp format defined by RFC3339.

timeUpdated string

The date and time the resource was last updated, in the timestamp format defined by RFC3339.

id str

The provider-assigned unique ID for this managed resource.

lifecycle_details str

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.

state str

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.

time_created str

The date and time the resource was created, in the timestamp format defined by RFC3339.

time_updated str

The date and time the resource was last updated, in the timestamp format defined by RFC3339.

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

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.

state String

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.

timeCreated String

The date and time the resource was created, in the timestamp format defined by RFC3339.

timeUpdated String

The date and time the resource was last updated, in the timestamp format defined by RFC3339.

Look up an Existing Dataset Resource

Get an existing Dataset resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DatasetState, opts?: CustomResourceOptions): Dataset
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        annotation_format: Optional[str] = None,
        compartment_id: Optional[str] = None,
        dataset_format_details: Optional[_datalabellingservice.DatasetDatasetFormatDetailsArgs] = None,
        dataset_source_details: Optional[_datalabellingservice.DatasetDatasetSourceDetailsArgs] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        initial_record_generation_configuration: Optional[_datalabellingservice.DatasetInitialRecordGenerationConfigurationArgs] = None,
        label_set: Optional[_datalabellingservice.DatasetLabelSetArgs] = None,
        labeling_instructions: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> Dataset
func GetDataset(ctx *Context, name string, id IDInput, state *DatasetState, opts ...ResourceOption) (*Dataset, error)
public static Dataset Get(string name, Input<string> id, DatasetState? state, CustomResourceOptions? opts = null)
public static Dataset get(String name, Output<String> id, DatasetState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AnnotationFormat string

The annotation format name required for labeling records.

CompartmentId string

(Updatable) The OCID of the compartment of the resource.

DatasetFormatDetails DatasetDatasetFormatDetailsArgs

It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.

DatasetSourceDetails DatasetDatasetSourceDetailsArgs

This allows the customer to specify the source of the dataset.

DefinedTags Dictionary<string, object>

(Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}

Description string

(Updatable) A user provided description of the dataset

DisplayName string

(Updatable) A user-friendly display name for the resource.

FreeformTags Dictionary<string, object>

(Updatable) 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"}

InitialRecordGenerationConfiguration DatasetInitialRecordGenerationConfigurationArgs

The initial generate records configuration. It generates records from the dataset's source.

LabelSet DatasetLabelSetArgs

An ordered collection of labels that are unique by name.

LabelingInstructions string

(Updatable) The labeling instructions for human labelers in rich text format

LifecycleDetails string

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.

State string

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.

TimeCreated string

The date and time the resource was created, in the timestamp format defined by RFC3339.

TimeUpdated string

The date and time the resource was last updated, in the timestamp format defined by RFC3339.

AnnotationFormat string

The annotation format name required for labeling records.

CompartmentId string

(Updatable) The OCID of the compartment of the resource.

DatasetFormatDetails DatasetDatasetFormatDetailsArgs

It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.

DatasetSourceDetails DatasetDatasetSourceDetailsArgs

This allows the customer to specify the source of the dataset.

DefinedTags map[string]interface{}

(Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}

Description string

(Updatable) A user provided description of the dataset

DisplayName string

(Updatable) A user-friendly display name for the resource.

FreeformTags map[string]interface{}

(Updatable) 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"}

InitialRecordGenerationConfiguration DatasetInitialRecordGenerationConfigurationArgs

The initial generate records configuration. It generates records from the dataset's source.

LabelSet DatasetLabelSetArgs

An ordered collection of labels that are unique by name.

LabelingInstructions string

(Updatable) The labeling instructions for human labelers in rich text format

LifecycleDetails string

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.

State string

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.

TimeCreated string

The date and time the resource was created, in the timestamp format defined by RFC3339.

TimeUpdated string

The date and time the resource was last updated, in the timestamp format defined by RFC3339.

annotationFormat String

The annotation format name required for labeling records.

compartmentId String

(Updatable) The OCID of the compartment of the resource.

datasetFormatDetails DatasetDatasetFormatDetailsArgs

It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.

datasetSourceDetails DatasetDatasetSourceDetailsArgs

This allows the customer to specify the source of the dataset.

definedTags Map<String,Object>

(Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}

description String

(Updatable) A user provided description of the dataset

displayName String

(Updatable) A user-friendly display name for the resource.

freeformTags Map<String,Object>

(Updatable) 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"}

initialRecordGenerationConfiguration DatasetInitialRecordGenerationConfigurationArgs

The initial generate records configuration. It generates records from the dataset's source.

labelSet DatasetLabelSetArgs

An ordered collection of labels that are unique by name.

labelingInstructions String

(Updatable) The labeling instructions for human labelers in rich text format

lifecycleDetails String

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.

state String

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.

timeCreated String

The date and time the resource was created, in the timestamp format defined by RFC3339.

timeUpdated String

The date and time the resource was last updated, in the timestamp format defined by RFC3339.

annotationFormat string

The annotation format name required for labeling records.

compartmentId string

(Updatable) The OCID of the compartment of the resource.

datasetFormatDetails DatasetDatasetFormatDetailsArgs

It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.

datasetSourceDetails DatasetDatasetSourceDetailsArgs

This allows the customer to specify the source of the dataset.

definedTags {[key: string]: any}

(Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}

description string

(Updatable) A user provided description of the dataset

displayName string

(Updatable) A user-friendly display name for the resource.

freeformTags {[key: string]: any}

(Updatable) 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"}

initialRecordGenerationConfiguration DatasetInitialRecordGenerationConfigurationArgs

The initial generate records configuration. It generates records from the dataset's source.

labelSet DatasetLabelSetArgs

An ordered collection of labels that are unique by name.

labelingInstructions string

(Updatable) The labeling instructions for human labelers in rich text format

lifecycleDetails string

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.

state string

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.

timeCreated string

The date and time the resource was created, in the timestamp format defined by RFC3339.

timeUpdated string

The date and time the resource was last updated, in the timestamp format defined by RFC3339.

annotation_format str

The annotation format name required for labeling records.

compartment_id str

(Updatable) The OCID of the compartment of the resource.

dataset_format_details DatasetDatasetFormatDetailsArgs

It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.

dataset_source_details DatasetDatasetSourceDetailsArgs

This allows the customer to specify the source of the dataset.

defined_tags Mapping[str, Any]

(Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}

description str

(Updatable) A user provided description of the dataset

display_name str

(Updatable) A user-friendly display name for the resource.

freeform_tags Mapping[str, Any]

(Updatable) 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"}

initial_record_generation_configuration DatasetInitialRecordGenerationConfigurationArgs

The initial generate records configuration. It generates records from the dataset's source.

label_set DatasetLabelSetArgs

An ordered collection of labels that are unique by name.

labeling_instructions str

(Updatable) The labeling instructions for human labelers in rich text format

lifecycle_details str

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.

state str

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.

time_created str

The date and time the resource was created, in the timestamp format defined by RFC3339.

time_updated str

The date and time the resource was last updated, in the timestamp format defined by RFC3339.

annotationFormat String

The annotation format name required for labeling records.

compartmentId String

(Updatable) The OCID of the compartment of the resource.

datasetFormatDetails Property Map

It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.

datasetSourceDetails Property Map

This allows the customer to specify the source of the dataset.

definedTags Map<Any>

(Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}

description String

(Updatable) A user provided description of the dataset

displayName String

(Updatable) A user-friendly display name for the resource.

freeformTags Map<Any>

(Updatable) 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"}

initialRecordGenerationConfiguration Property Map

The initial generate records configuration. It generates records from the dataset's source.

labelSet Property Map

An ordered collection of labels that are unique by name.

labelingInstructions String

(Updatable) The labeling instructions for human labelers in rich text format

lifecycleDetails String

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.

state String

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.

timeCreated String

The date and time the resource was created, in the timestamp format defined by RFC3339.

timeUpdated String

The date and time the resource was last updated, in the timestamp format defined by RFC3339.

Supporting Types

DatasetDatasetFormatDetails

FormatType string

It defines the format type of text files.

TextFileTypeMetadata DatasetDatasetFormatDetailsTextFileTypeMetadata

Metadata for files with text content.

FormatType string

It defines the format type of text files.

TextFileTypeMetadata DatasetDatasetFormatDetailsTextFileTypeMetadata

Metadata for files with text content.

formatType String

It defines the format type of text files.

textFileTypeMetadata DatasetDatasetFormatDetailsTextFileTypeMetadata

Metadata for files with text content.

formatType string

It defines the format type of text files.

textFileTypeMetadata DatasetDatasetFormatDetailsTextFileTypeMetadata

Metadata for files with text content.

format_type str

It defines the format type of text files.

text_file_type_metadata DatasetDatasetFormatDetailsTextFileTypeMetadata

Metadata for files with text content.

formatType String

It defines the format type of text files.

textFileTypeMetadata Property Map

Metadata for files with text content.

DatasetDatasetFormatDetailsTextFileTypeMetadata

ColumnIndex int

The index of a selected column. This is a zero-based index.

FormatType string

It defines the format type of text files.

ColumnDelimiter string

A column delimiter

ColumnName string

The name of a selected column.

EscapeCharacter string

An escape character.

LineDelimiter string

A line delimiter.

ColumnIndex int

The index of a selected column. This is a zero-based index.

FormatType string

It defines the format type of text files.

ColumnDelimiter string

A column delimiter

ColumnName string

The name of a selected column.

EscapeCharacter string

An escape character.

LineDelimiter string

A line delimiter.

columnIndex Integer

The index of a selected column. This is a zero-based index.

formatType String

It defines the format type of text files.

columnDelimiter String

A column delimiter

columnName String

The name of a selected column.

escapeCharacter String

An escape character.

lineDelimiter String

A line delimiter.

columnIndex number

The index of a selected column. This is a zero-based index.

formatType string

It defines the format type of text files.

columnDelimiter string

A column delimiter

columnName string

The name of a selected column.

escapeCharacter string

An escape character.

lineDelimiter string

A line delimiter.

column_index int

The index of a selected column. This is a zero-based index.

format_type str

It defines the format type of text files.

column_delimiter str

A column delimiter

column_name str

The name of a selected column.

escape_character str

An escape character.

line_delimiter str

A line delimiter.

columnIndex Number

The index of a selected column. This is a zero-based index.

formatType String

It defines the format type of text files.

columnDelimiter String

A column delimiter

columnName String

The name of a selected column.

escapeCharacter String

An escape character.

lineDelimiter String

A line delimiter.

DatasetDatasetSourceDetails

Bucket string

The object storage bucket that contains the dataset data source.

Namespace string

The namespace of the bucket that contains the dataset data source.

SourceType string

The source type. OBJECT_STORAGE allows the user to describe where in object storage the dataset is.

Prefix string

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.

Bucket string

The object storage bucket that contains the dataset data source.

Namespace string

The namespace of the bucket that contains the dataset data source.

SourceType string

The source type. OBJECT_STORAGE allows the user to describe where in object storage the dataset is.

Prefix string

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.

bucket String

The object storage bucket that contains the dataset data source.

namespace String

The namespace of the bucket that contains the dataset data source.

sourceType String

The source type. OBJECT_STORAGE allows the user to describe where in object storage the dataset is.

prefix String

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.

bucket string

The object storage bucket that contains the dataset data source.

namespace string

The namespace of the bucket that contains the dataset data source.

sourceType string

The source type. OBJECT_STORAGE allows the user to describe where in object storage the dataset is.

prefix string

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.

bucket str

The object storage bucket that contains the dataset data source.

namespace str

The namespace of the bucket that contains the dataset data source.

source_type str

The source type. OBJECT_STORAGE allows the user to describe where in object storage the dataset is.

prefix str

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.

bucket String

The object storage bucket that contains the dataset data source.

namespace String

The namespace of the bucket that contains the dataset data source.

sourceType String

The source type. OBJECT_STORAGE allows the user to describe where in object storage the dataset is.

prefix String

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.

DatasetLabelSet

Items List<DatasetLabelSetItem>

An ordered collection of labels that are unique by name.

Items []DatasetLabelSetItem

An ordered collection of labels that are unique by name.

items List<DatasetLabelSetItem>

An ordered collection of labels that are unique by name.

items DatasetLabelSetItem[]

An ordered collection of labels that are unique by name.

items DatasetLabelSetItem]

An ordered collection of labels that are unique by name.

items List<Property Map>

An ordered collection of labels that are unique by name.

DatasetLabelSetItem

Name string

An unique name for a label within its dataset.

Name string

An unique name for a label within its dataset.

name String

An unique name for a label within its dataset.

name string

An unique name for a label within its dataset.

name str

An unique name for a label within its dataset.

name String

An unique name for a label within its dataset.

Import

Datasets can be imported using the id, e.g.

 $ pulumi import oci:DataLabellingService/dataset:Dataset test_dataset "id"

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.