1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataLabellingService
  5. getDataset
Oracle Cloud Infrastructure v0.20.1 published on Tuesday, Jun 6, 2023 by Pulumi

oci.DataLabellingService.getDataset

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v0.20.1 published on Tuesday, Jun 6, 2023 by Pulumi

    This data source provides details about a specific Dataset resource in Oracle Cloud Infrastructure Data Labeling Service service.

    Gets a Dataset by identifier

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testDataset = Oci.DataLabellingService.GetDataset.Invoke(new()
        {
            DatasetId = oci_data_labeling_service_dataset.Test_dataset.Id,
        });
    
    });
    
    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.GetDataset(ctx, &datalabellingservice.GetDatasetArgs{
    			DatasetId: oci_data_labeling_service_dataset.Test_dataset.Id,
    		}, nil)
    		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.DataLabellingServiceFunctions;
    import com.pulumi.oci.DataLabellingService.inputs.GetDatasetArgs;
    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) {
            final var testDataset = DataLabellingServiceFunctions.getDataset(GetDatasetArgs.builder()
                .datasetId(oci_data_labeling_service_dataset.test_dataset().id())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_oci as oci
    
    test_dataset = oci.DataLabellingService.get_dataset(dataset_id=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testDataset = oci.DataLabellingService.getDataset({
        datasetId: oci_data_labeling_service_dataset.test_dataset.id,
    });
    
    variables:
      testDataset:
        fn::invoke:
          Function: oci:DataLabellingService:getDataset
          Arguments:
            datasetId: ${oci_data_labeling_service_dataset.test_dataset.id}
    

    Using getDataset

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDataset(args: GetDatasetArgs, opts?: InvokeOptions): Promise<GetDatasetResult>
    function getDatasetOutput(args: GetDatasetOutputArgs, opts?: InvokeOptions): Output<GetDatasetResult>
    def get_dataset(dataset_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDatasetResult
    def get_dataset_output(dataset_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDatasetResult]
    func GetDataset(ctx *Context, args *GetDatasetArgs, opts ...InvokeOption) (*GetDatasetResult, error)
    func GetDatasetOutput(ctx *Context, args *GetDatasetOutputArgs, opts ...InvokeOption) GetDatasetResultOutput

    > Note: This function is named GetDataset in the Go SDK.

    public static class GetDataset 
    {
        public static Task<GetDatasetResult> InvokeAsync(GetDatasetArgs args, InvokeOptions? opts = null)
        public static Output<GetDatasetResult> Invoke(GetDatasetInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDatasetResult> getDataset(GetDatasetArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:DataLabellingService/getDataset:getDataset
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DatasetId string

    Unique Dataset OCID

    DatasetId string

    Unique Dataset OCID

    datasetId String

    Unique Dataset OCID

    datasetId string

    Unique Dataset OCID

    dataset_id str

    Unique Dataset OCID

    datasetId String

    Unique Dataset OCID

    getDataset Result

    The following output properties are available:

    AnnotationFormat string

    The annotation format name required for labeling records.

    CompartmentId string

    The OCID of the compartment of the resource.

    DatasetFormatDetails List<GetDatasetDatasetFormatDetail>

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

    DatasetId string
    DatasetSourceDetails List<GetDatasetDatasetSourceDetail>

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

    DefinedTags Dictionary<string, object>

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

    Description string

    A user provided description of the dataset

    DisplayName string

    A user-friendly display name for the resource.

    FreeformTags Dictionary<string, object>

    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"}

    Id string

    The OCID of the Dataset.

    InitialRecordGenerationConfigurations List<GetDatasetInitialRecordGenerationConfiguration>

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

    LabelSets List<GetDatasetLabelSet>

    An ordered collection of labels that are unique by name.

    LabelingInstructions string

    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

    The OCID of the compartment of the resource.

    DatasetFormatDetails []GetDatasetDatasetFormatDetail

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

    DatasetId string
    DatasetSourceDetails []GetDatasetDatasetSourceDetail

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

    DefinedTags map[string]interface{}

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

    Description string

    A user provided description of the dataset

    DisplayName string

    A user-friendly display name for the resource.

    FreeformTags map[string]interface{}

    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"}

    Id string

    The OCID of the Dataset.

    InitialRecordGenerationConfigurations []GetDatasetInitialRecordGenerationConfiguration

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

    LabelSets []GetDatasetLabelSet

    An ordered collection of labels that are unique by name.

    LabelingInstructions string

    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

    The OCID of the compartment of the resource.

    datasetFormatDetails List<GetDatasetDatasetFormatDetail>

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

    datasetId String
    datasetSourceDetails List<GetDatasetDatasetSourceDetail>

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

    definedTags Map<String,Object>

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

    description String

    A user provided description of the dataset

    displayName String

    A user-friendly display name for the resource.

    freeformTags Map<String,Object>

    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"}

    id String

    The OCID of the Dataset.

    initialRecordGenerationConfigurations List<GetDatasetInitialRecordGenerationConfiguration>

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

    labelSets List<GetDatasetLabelSet>

    An ordered collection of labels that are unique by name.

    labelingInstructions String

    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

    The OCID of the compartment of the resource.

    datasetFormatDetails GetDatasetDatasetFormatDetail[]

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

    datasetId string
    datasetSourceDetails GetDatasetDatasetSourceDetail[]

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

    definedTags {[key: string]: any}

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

    description string

    A user provided description of the dataset

    displayName string

    A user-friendly display name for the resource.

    freeformTags {[key: string]: any}

    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"}

    id string

    The OCID of the Dataset.

    initialRecordGenerationConfigurations GetDatasetInitialRecordGenerationConfiguration[]

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

    labelSets GetDatasetLabelSet[]

    An ordered collection of labels that are unique by name.

    labelingInstructions string

    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

    The OCID of the compartment of the resource.

    dataset_format_details GetDatasetDatasetFormatDetail]

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

    dataset_id str
    dataset_source_details GetDatasetDatasetSourceDetail]

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

    defined_tags Mapping[str, Any]

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

    description str

    A user provided description of the dataset

    display_name str

    A user-friendly display name for the resource.

    freeform_tags Mapping[str, Any]

    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"}

    id str

    The OCID of the Dataset.

    initial_record_generation_configurations GetDatasetInitialRecordGenerationConfiguration]

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

    label_sets GetDatasetLabelSet]

    An ordered collection of labels that are unique by name.

    labeling_instructions str

    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

    The OCID of the compartment of the resource.

    datasetFormatDetails List<Property Map>

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

    datasetId String
    datasetSourceDetails List<Property Map>

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

    definedTags Map<Any>

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

    description String

    A user provided description of the dataset

    displayName String

    A user-friendly display name for the resource.

    freeformTags Map<Any>

    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"}

    id String

    The OCID of the Dataset.

    initialRecordGenerationConfigurations List<Property Map>

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

    labelSets List<Property Map>

    An ordered collection of labels that are unique by name.

    labelingInstructions String

    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

    GetDatasetDatasetFormatDetail

    FormatType string

    It defines the format type of text files.

    TextFileTypeMetadatas List<GetDatasetDatasetFormatDetailTextFileTypeMetadata>

    Metadata for files with text content.

    FormatType string

    It defines the format type of text files.

    TextFileTypeMetadatas []GetDatasetDatasetFormatDetailTextFileTypeMetadata

    Metadata for files with text content.

    formatType String

    It defines the format type of text files.

    textFileTypeMetadatas List<GetDatasetDatasetFormatDetailTextFileTypeMetadata>

    Metadata for files with text content.

    formatType string

    It defines the format type of text files.

    textFileTypeMetadatas GetDatasetDatasetFormatDetailTextFileTypeMetadata[]

    Metadata for files with text content.

    format_type str

    It defines the format type of text files.

    text_file_type_metadatas GetDatasetDatasetFormatDetailTextFileTypeMetadata]

    Metadata for files with text content.

    formatType String

    It defines the format type of text files.

    textFileTypeMetadatas List<Property Map>

    Metadata for files with text content.

    GetDatasetDatasetFormatDetailTextFileTypeMetadata

    ColumnDelimiter string

    A column delimiter

    ColumnIndex int

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

    ColumnName string

    The name of a selected column.

    EscapeCharacter string

    An escape character.

    FormatType string

    It defines the format type of text files.

    LineDelimiter string

    A line delimiter.

    ColumnDelimiter string

    A column delimiter

    ColumnIndex int

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

    ColumnName string

    The name of a selected column.

    EscapeCharacter string

    An escape character.

    FormatType string

    It defines the format type of text files.

    LineDelimiter string

    A line delimiter.

    columnDelimiter String

    A column delimiter

    columnIndex Integer

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

    columnName String

    The name of a selected column.

    escapeCharacter String

    An escape character.

    formatType String

    It defines the format type of text files.

    lineDelimiter String

    A line delimiter.

    columnDelimiter string

    A column delimiter

    columnIndex number

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

    columnName string

    The name of a selected column.

    escapeCharacter string

    An escape character.

    formatType string

    It defines the format type of text files.

    lineDelimiter string

    A line delimiter.

    column_delimiter str

    A column delimiter

    column_index int

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

    column_name str

    The name of a selected column.

    escape_character str

    An escape character.

    format_type str

    It defines the format type of text files.

    line_delimiter str

    A line delimiter.

    columnDelimiter String

    A column delimiter

    columnIndex Number

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

    columnName String

    The name of a selected column.

    escapeCharacter String

    An escape character.

    formatType String

    It defines the format type of text files.

    lineDelimiter String

    A line delimiter.

    GetDatasetDatasetSourceDetail

    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.

    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.

    SourceType string

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

    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.

    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.

    SourceType string

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

    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.

    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.

    sourceType String

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

    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.

    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.

    sourceType string

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

    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.

    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.

    source_type str

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

    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.

    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.

    sourceType String

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

    GetDatasetLabelSet

    Items List<GetDatasetLabelSetItem>

    An ordered collection of labels that are unique by name.

    Items []GetDatasetLabelSetItem

    An ordered collection of labels that are unique by name.

    items List<GetDatasetLabelSetItem>

    An ordered collection of labels that are unique by name.

    items GetDatasetLabelSetItem[]

    An ordered collection of labels that are unique by name.

    items GetDatasetLabelSetItem]

    An ordered collection of labels that are unique by name.

    items List<Property Map>

    An ordered collection of labels that are unique by name.

    GetDatasetLabelSetItem

    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.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the oci Terraform Provider.

    oci logo
    Oracle Cloud Infrastructure v0.20.1 published on Tuesday, Jun 6, 2023 by Pulumi