import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Dataset resource in Oracle Cloud Infrastructure Data Labeling Service service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/datalabeling/latest/Dataset * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/datalabeling * * Creates a new Dataset. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testDataset = new oci.datalabellingservice.Dataset("test_dataset", { * annotationFormat: datasetAnnotationFormat, * compartmentId: compartmentId, * datasetFormatDetails: { * formatType: datasetDatasetFormatDetailsFormatType, * textFileTypeMetadata: { * columnIndex: Number(datasetDatasetFormatDetailsTextFileTypeMetadataColumnIndex), * formatType: datasetDatasetFormatDetailsTextFileTypeMetadataFormatType, * columnDelimiter: datasetDatasetFormatDetailsTextFileTypeMetadataColumnDelimiter, * columnName: datasetDatasetFormatDetailsTextFileTypeMetadataColumnName, * escapeCharacter: datasetDatasetFormatDetailsTextFileTypeMetadataEscapeCharacter, * lineDelimiter: datasetDatasetFormatDetailsTextFileTypeMetadataLineDelimiter, * }, * }, * datasetSourceDetails: { * bucket: datasetDatasetSourceDetailsBucket, * namespace: datasetDatasetSourceDetailsNamespace, * sourceType: datasetDatasetSourceDetailsSourceType, * prefix: datasetDatasetSourceDetailsPrefix, * }, * labelSet: { * items: [{ * name: datasetLabelSetItemsName, * }], * }, * definedTags: datasetDefinedTags, * description: datasetDescription, * displayName: datasetDisplayName, * freeformTags: datasetFreeformTags, * initialImportDatasetConfiguration: { * importFormat: { * name: datasetInitialImportDatasetConfigurationImportFormatName, * version: datasetInitialImportDatasetConfigurationImportFormatVersion, * }, * importMetadataPath: { * bucket: datasetInitialImportDatasetConfigurationImportMetadataPathBucket, * namespace: datasetInitialImportDatasetConfigurationImportMetadataPathNamespace, * path: datasetInitialImportDatasetConfigurationImportMetadataPathPath, * sourceType: datasetInitialImportDatasetConfigurationImportMetadataPathSourceType, * }, * }, * initialRecordGenerationConfiguration: {}, * labelingInstructions: datasetLabelingInstructions, * }); * ``` * * ## Import * * Datasets can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:DataLabellingService/dataset:Dataset test_dataset "id" * ``` */ export declare class Dataset extends pulumi.CustomResource { /** * Get an existing Dataset resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: DatasetState, opts?: pulumi.CustomResourceOptions): Dataset; /** * Returns true if the given object is an instance of Dataset. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Dataset; /** * 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"}` */ readonly additionalProperties: pulumi.Output<{ [key: string]: string; }>; /** * The annotation format name required for labeling records. */ readonly annotationFormat: pulumi.Output; /** * (Updatable) The OCID of the compartment of the resource. */ readonly compartmentId: pulumi.Output; /** * It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT. */ readonly datasetFormatDetails: pulumi.Output; /** * This allows the customer to specify the source of the dataset. */ readonly datasetSourceDetails: pulumi.Output; /** * (Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) A user provided description of the dataset */ readonly description: pulumi.Output; /** * (Updatable) A user-friendly display name for the resource. */ readonly displayName: pulumi.Output; /** * (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"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * Initial import dataset configuration. Allows user to create dataset from existing dataset files. */ readonly initialImportDatasetConfiguration: pulumi.Output; /** * The initial generate records configuration. It generates records from the dataset's source. */ readonly initialRecordGenerationConfiguration: pulumi.Output; /** * An ordered collection of labels that are unique by name. */ readonly labelSet: pulumi.Output; /** * (Updatable) The labeling instructions for human labelers in rich text format * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ readonly labelingInstructions: pulumi.Output; /** * 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. */ readonly lifecycleDetails: pulumi.Output; /** * The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported. */ readonly lifecycleSubstate: pulumi.Output; /** * 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. */ readonly state: pulumi.Output; /** * The date and time the resource was created, in the timestamp format defined by RFC3339. */ readonly timeCreated: pulumi.Output; /** * The date and time the resource was last updated, in the timestamp format defined by RFC3339. */ readonly timeUpdated: pulumi.Output; /** * Create a Dataset resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: DatasetArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Dataset resources. */ export interface DatasetState { /** * 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"}` */ additionalProperties?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The annotation format name required for labeling records. */ annotationFormat?: pulumi.Input; /** * (Updatable) The OCID of the compartment of the resource. */ compartmentId?: pulumi.Input; /** * It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT. */ datasetFormatDetails?: pulumi.Input; /** * This allows the customer to specify the source of the dataset. */ datasetSourceDetails?: pulumi.Input; /** * (Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user provided description of the dataset */ description?: pulumi.Input; /** * (Updatable) A user-friendly display name for the resource. */ displayName?: pulumi.Input; /** * (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"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Initial import dataset configuration. Allows user to create dataset from existing dataset files. */ initialImportDatasetConfiguration?: pulumi.Input; /** * The initial generate records configuration. It generates records from the dataset's source. */ initialRecordGenerationConfiguration?: pulumi.Input; /** * An ordered collection of labels that are unique by name. */ labelSet?: pulumi.Input; /** * (Updatable) The labeling instructions for human labelers in rich text format * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ labelingInstructions?: pulumi.Input; /** * 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. */ lifecycleDetails?: pulumi.Input; /** * The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported. */ lifecycleSubstate?: pulumi.Input; /** * 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. */ state?: pulumi.Input; /** * The date and time the resource was created, in the timestamp format defined by RFC3339. */ timeCreated?: pulumi.Input; /** * The date and time the resource was last updated, in the timestamp format defined by RFC3339. */ timeUpdated?: pulumi.Input; } /** * The set of arguments for constructing a Dataset resource. */ export interface DatasetArgs { /** * The annotation format name required for labeling records. */ annotationFormat: pulumi.Input; /** * (Updatable) The OCID of the compartment of the resource. */ compartmentId: pulumi.Input; /** * It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT. */ datasetFormatDetails: pulumi.Input; /** * This allows the customer to specify the source of the dataset. */ datasetSourceDetails: pulumi.Input; /** * (Updatable) The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user provided description of the dataset */ description?: pulumi.Input; /** * (Updatable) A user-friendly display name for the resource. */ displayName?: pulumi.Input; /** * (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"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * Initial import dataset configuration. Allows user to create dataset from existing dataset files. */ initialImportDatasetConfiguration?: pulumi.Input; /** * The initial generate records configuration. It generates records from the dataset's source. */ initialRecordGenerationConfiguration?: pulumi.Input; /** * An ordered collection of labels that are unique by name. */ labelSet: pulumi.Input; /** * (Updatable) The labeling instructions for human labelers in rich text format * * ** IMPORTANT ** * Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values */ labelingInstructions?: pulumi.Input; } //# sourceMappingURL=dataset.d.ts.map