Oracle Cloud Infrastructure
getDataset
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 Pulumi;
using Oci = Pulumi.Oci;
class MyStack : Stack
{
public MyStack()
{
var testDataset = Output.Create(Oci.DataLabellingService.GetDataset.InvokeAsync(new Oci.DataLabellingService.GetDatasetArgs
{
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
})
}
Coming soon!
import pulumi
import pulumi_oci as oci
test_dataset = oci.DataLabellingService.get_dataset(dataset_id=oci_data_labeling_service_dataset["test_dataset"]["id"])
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,
});
Coming soon!
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:
- Dataset
Id string Unique Dataset OCID
- Dataset
Id string Unique Dataset OCID
- dataset
Id String Unique Dataset OCID
- dataset
Id string Unique Dataset OCID
- dataset_
id str Unique Dataset OCID
- dataset
Id String Unique Dataset OCID
getDataset Result
The following output properties are available:
- Annotation
Format string The annotation format name required for labeling records.
- Compartment
Id string The OCID of the compartment of the resource.
- Dataset
Format List<GetDetails Dataset Dataset Format Detail> Specifies how to process the data. Supported formats include DOCUMENT, IMAGE and TEXT.
- Dataset
Id string - Dataset
Source List<GetDetails Dataset Dataset Source Detail> This allows the customer to specify the source of the dataset.
- 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
- Display
Name string A user-friendly display name for the resource.
- 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.
- Initial
Record List<GetGeneration Configurations Dataset Initial Record Generation Configuration> Initial Generate Records configuration, generates records from the Dataset's source.
- Label
Sets List<GetDataset Label Set> An ordered collection of Labels that are unique by name.
- Labeling
Instructions string The labeling instructions for human labelers in rich text format
- Lifecycle
Details 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.
- Time
Created string The date and time the resource was created, in the timestamp format defined by RFC3339.
- Time
Updated string The date and time the resource was last updated, in the timestamp format defined by RFC3339.
- Annotation
Format string The annotation format name required for labeling records.
- Compartment
Id string The OCID of the compartment of the resource.
- Dataset
Format []GetDetails Dataset Dataset Format Detail Specifies how to process the data. Supported formats include DOCUMENT, IMAGE and TEXT.
- Dataset
Id string - Dataset
Source []GetDetails Dataset Dataset Source Detail This allows the customer to specify the source of the dataset.
- 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
- Display
Name string A user-friendly display name for the resource.
- 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.
- Initial
Record []GetGeneration Configurations Dataset Initial Record Generation Configuration Initial Generate Records configuration, generates records from the Dataset's source.
- Label
Sets []GetDataset Label Set An ordered collection of Labels that are unique by name.
- Labeling
Instructions string The labeling instructions for human labelers in rich text format
- Lifecycle
Details 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.
- Time
Created string The date and time the resource was created, in the timestamp format defined by RFC3339.
- Time
Updated string The date and time the resource was last updated, in the timestamp format defined by RFC3339.
- annotation
Format String The annotation format name required for labeling records.
- compartment
Id String The OCID of the compartment of the resource.
- dataset
Format List<GetDetails Dataset Dataset Format Detail> Specifies how to process the data. Supported formats include DOCUMENT, IMAGE and TEXT.
- dataset
Id String - dataset
Source List<GetDetails Dataset Dataset Source Detail> This allows the customer to specify the source of the dataset.
- 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
- display
Name String A user-friendly display name for the resource.
- 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.
- initial
Record List<GetGeneration Configurations Dataset Initial Record Generation Configuration> Initial Generate Records configuration, generates records from the Dataset's source.
- label
Sets List<GetDataset Label Set> An ordered collection of Labels that are unique by name.
- labeling
Instructions String The labeling instructions for human labelers in rich text format
- lifecycle
Details 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.
- time
Created String The date and time the resource was created, in the timestamp format defined by RFC3339.
- time
Updated String The date and time the resource was last updated, in the timestamp format defined by RFC3339.
- annotation
Format string The annotation format name required for labeling records.
- compartment
Id string The OCID of the compartment of the resource.
- dataset
Format GetDetails Dataset Dataset Format Detail[] Specifies how to process the data. Supported formats include DOCUMENT, IMAGE and TEXT.
- dataset
Id string - dataset
Source GetDetails Dataset Dataset Source Detail[] This allows the customer to specify the source of the dataset.
- {[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
- display
Name string A user-friendly display name for the resource.
- {[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.
- initial
Record GetGeneration Configurations Dataset Initial Record Generation Configuration[] Initial Generate Records configuration, generates records from the Dataset's source.
- label
Sets GetDataset Label Set[] An ordered collection of Labels that are unique by name.
- labeling
Instructions string The labeling instructions for human labelers in rich text format
- lifecycle
Details 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.
- time
Created string The date and time the resource was created, in the timestamp format defined by RFC3339.
- time
Updated 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_ Getdetails Dataset Dataset Format Detail] Specifies how to process the data. Supported formats include DOCUMENT, IMAGE and TEXT.
- dataset_
id str - dataset_
source_ Getdetails Dataset Dataset Source Detail] This allows the customer to specify the source of the dataset.
- 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.
- 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_ Getgeneration_ configurations Dataset Initial Record Generation Configuration] Initial Generate Records configuration, generates records from the Dataset's source.
- label_
sets GetDataset Label Set] 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.
- annotation
Format String The annotation format name required for labeling records.
- compartment
Id String The OCID of the compartment of the resource.
- dataset
Format List<Property Map>Details Specifies how to process the data. Supported formats include DOCUMENT, IMAGE and TEXT.
- dataset
Id String - dataset
Source List<Property Map>Details This allows the customer to specify the source of the dataset.
- 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
- display
Name String A user-friendly display name for the resource.
- 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.
- initial
Record List<Property Map>Generation Configurations Initial Generate Records configuration, generates records from the Dataset's source.
- label
Sets List<Property Map> An ordered collection of Labels that are unique by name.
- labeling
Instructions String The labeling instructions for human labelers in rich text format
- lifecycle
Details 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.
- time
Created String The date and time the resource was created, in the timestamp format defined by RFC3339.
- time
Updated String The date and time the resource was last updated, in the timestamp format defined by RFC3339.
Supporting Types
GetDatasetDatasetFormatDetail
- Format
Type string Format type. DOCUMENT format is for record contents that are PDFs or TIFFs. IMAGE format is for record contents that are JPEGs or PNGs. TEXT format is for record contents that are txt files.
- Format
Type string Format type. DOCUMENT format is for record contents that are PDFs or TIFFs. IMAGE format is for record contents that are JPEGs or PNGs. TEXT format is for record contents that are txt files.
- format
Type String Format type. DOCUMENT format is for record contents that are PDFs or TIFFs. IMAGE format is for record contents that are JPEGs or PNGs. TEXT format is for record contents that are txt files.
- format
Type string Format type. DOCUMENT format is for record contents that are PDFs or TIFFs. IMAGE format is for record contents that are JPEGs or PNGs. TEXT format is for record contents that are txt files.
- format_
type str Format type. DOCUMENT format is for record contents that are PDFs or TIFFs. IMAGE format is for record contents that are JPEGs or PNGs. TEXT format is for record contents that are txt files.
- format
Type String Format type. DOCUMENT format is for record contents that are PDFs or TIFFs. IMAGE format is for record contents that are JPEGs or PNGs. TEXT format is for record contents that are txt files.
GetDatasetDatasetSourceDetail
- Bucket string
The object storage bucket that contains the dataset data source
- Namespace string
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. Records will not be generated for objects whose name match exactly with prefix.
- Source
Type string Source type. OBJECT_STORAGE allows the customer to describe where the dataset is in object storage.
- Bucket string
The object storage bucket that contains the dataset data source
- Namespace string
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. Records will not be generated for objects whose name match exactly with prefix.
- Source
Type string Source type. OBJECT_STORAGE allows the customer to describe where the dataset is in object storage.
- bucket String
The object storage bucket that contains the dataset data source
- namespace String
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. Records will not be generated for objects whose name match exactly with prefix.
- source
Type String Source type. OBJECT_STORAGE allows the customer to describe where the dataset is in object storage.
- bucket string
The object storage bucket that contains the dataset data source
- namespace string
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. Records will not be generated for objects whose name match exactly with prefix.
- source
Type string Source type. OBJECT_STORAGE allows the customer to describe where the dataset is in object storage.
- bucket str
The object storage bucket that contains the dataset data source
- namespace str
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. Records will not be generated for objects whose name match exactly with prefix.
- source_
type str Source type. OBJECT_STORAGE allows the customer to describe where the dataset is in object storage.
- bucket String
The object storage bucket that contains the dataset data source
- namespace String
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. Records will not be generated for objects whose name match exactly with prefix.
- source
Type String Source type. OBJECT_STORAGE allows the customer to describe where the dataset is in object storage.
GetDatasetLabelSet
- Items
List<Get
Dataset Label Set Item> An ordered collection of Labels that are unique by name.
- Items
[]Get
Dataset Label Set Item An ordered collection of Labels that are unique by name.
- items
List<Get
Dataset Label Set Item> An ordered collection of Labels that are unique by name.
- items
Get
Dataset Label Set Item[] An ordered collection of Labels that are unique by name.
- items
Get
Dataset Label Set Item] 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
- https://github.com/pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.