1. Packages
  2. Google Cloud Native
  3. API Docs
  4. datalabeling
  5. datalabeling/v1beta1
  6. getDataset

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.datalabeling/v1beta1.getDataset

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Gets dataset by resource name.

    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,
                    project: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDatasetResult
    def get_dataset_output(dataset_id: Optional[pulumi.Input[str]] = None,
                    project: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDatasetResult]
    func LookupDataset(ctx *Context, args *LookupDatasetArgs, opts ...InvokeOption) (*LookupDatasetResult, error)
    func LookupDatasetOutput(ctx *Context, args *LookupDatasetOutputArgs, opts ...InvokeOption) LookupDatasetResultOutput

    > Note: This function is named LookupDataset 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: google-native:datalabeling/v1beta1:getDataset
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DatasetId string
    Project string
    DatasetId string
    Project string
    datasetId String
    project String
    datasetId string
    project string
    datasetId String
    project String

    getDataset Result

    The following output properties are available:

    BlockingResources List<string>
    The names of any related resources that are blocking changes to the dataset.
    CreateTime string
    Time the dataset is created.
    DataItemCount string
    The number of data items in the dataset.
    Description string
    Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.
    DisplayName string
    The display name of the dataset. Maximum of 64 characters.
    InputConfigs List<Pulumi.GoogleNative.DataLabeling.V1Beta1.Outputs.GoogleCloudDatalabelingV1beta1InputConfigResponse>
    This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.
    LastMigrateTime string
    Last time that the Dataset is migrated to AI Platform V2. If any of the AnnotatedDataset is migrated, the last_migration_time in Dataset is also updated.
    Name string
    Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}
    BlockingResources []string
    The names of any related resources that are blocking changes to the dataset.
    CreateTime string
    Time the dataset is created.
    DataItemCount string
    The number of data items in the dataset.
    Description string
    Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.
    DisplayName string
    The display name of the dataset. Maximum of 64 characters.
    InputConfigs []GoogleCloudDatalabelingV1beta1InputConfigResponse
    This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.
    LastMigrateTime string
    Last time that the Dataset is migrated to AI Platform V2. If any of the AnnotatedDataset is migrated, the last_migration_time in Dataset is also updated.
    Name string
    Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}
    blockingResources List<String>
    The names of any related resources that are blocking changes to the dataset.
    createTime String
    Time the dataset is created.
    dataItemCount String
    The number of data items in the dataset.
    description String
    Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.
    displayName String
    The display name of the dataset. Maximum of 64 characters.
    inputConfigs List<GoogleCloudDatalabelingV1beta1InputConfigResponse>
    This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.
    lastMigrateTime String
    Last time that the Dataset is migrated to AI Platform V2. If any of the AnnotatedDataset is migrated, the last_migration_time in Dataset is also updated.
    name String
    Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}
    blockingResources string[]
    The names of any related resources that are blocking changes to the dataset.
    createTime string
    Time the dataset is created.
    dataItemCount string
    The number of data items in the dataset.
    description string
    Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.
    displayName string
    The display name of the dataset. Maximum of 64 characters.
    inputConfigs GoogleCloudDatalabelingV1beta1InputConfigResponse[]
    This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.
    lastMigrateTime string
    Last time that the Dataset is migrated to AI Platform V2. If any of the AnnotatedDataset is migrated, the last_migration_time in Dataset is also updated.
    name string
    Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}
    blocking_resources Sequence[str]
    The names of any related resources that are blocking changes to the dataset.
    create_time str
    Time the dataset is created.
    data_item_count str
    The number of data items in the dataset.
    description str
    Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.
    display_name str
    The display name of the dataset. Maximum of 64 characters.
    input_configs Sequence[GoogleCloudDatalabelingV1beta1InputConfigResponse]
    This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.
    last_migrate_time str
    Last time that the Dataset is migrated to AI Platform V2. If any of the AnnotatedDataset is migrated, the last_migration_time in Dataset is also updated.
    name str
    Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}
    blockingResources List<String>
    The names of any related resources that are blocking changes to the dataset.
    createTime String
    Time the dataset is created.
    dataItemCount String
    The number of data items in the dataset.
    description String
    Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.
    displayName String
    The display name of the dataset. Maximum of 64 characters.
    inputConfigs List<Property Map>
    This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.
    lastMigrateTime String
    Last time that the Dataset is migrated to AI Platform V2. If any of the AnnotatedDataset is migrated, the last_migration_time in Dataset is also updated.
    name String
    Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}

    Supporting Types

    GoogleCloudDatalabelingV1beta1BigQuerySourceResponse

    InputUri string
    BigQuery URI to a table, up to 2,000 characters long. If you specify the URI of a table that does not exist, Data Labeling Service creates a table at the URI with the correct schema when you create your EvaluationJob. If you specify the URI of a table that already exists, it must have the correct schema. Provide the table URI in the following format: "bq://{your_project_id}/ {your_dataset_name}/{your_table_name}" Learn more.
    InputUri string
    BigQuery URI to a table, up to 2,000 characters long. If you specify the URI of a table that does not exist, Data Labeling Service creates a table at the URI with the correct schema when you create your EvaluationJob. If you specify the URI of a table that already exists, it must have the correct schema. Provide the table URI in the following format: "bq://{your_project_id}/ {your_dataset_name}/{your_table_name}" Learn more.
    inputUri String
    BigQuery URI to a table, up to 2,000 characters long. If you specify the URI of a table that does not exist, Data Labeling Service creates a table at the URI with the correct schema when you create your EvaluationJob. If you specify the URI of a table that already exists, it must have the correct schema. Provide the table URI in the following format: "bq://{your_project_id}/ {your_dataset_name}/{your_table_name}" Learn more.
    inputUri string
    BigQuery URI to a table, up to 2,000 characters long. If you specify the URI of a table that does not exist, Data Labeling Service creates a table at the URI with the correct schema when you create your EvaluationJob. If you specify the URI of a table that already exists, it must have the correct schema. Provide the table URI in the following format: "bq://{your_project_id}/ {your_dataset_name}/{your_table_name}" Learn more.
    input_uri str
    BigQuery URI to a table, up to 2,000 characters long. If you specify the URI of a table that does not exist, Data Labeling Service creates a table at the URI with the correct schema when you create your EvaluationJob. If you specify the URI of a table that already exists, it must have the correct schema. Provide the table URI in the following format: "bq://{your_project_id}/ {your_dataset_name}/{your_table_name}" Learn more.
    inputUri String
    BigQuery URI to a table, up to 2,000 characters long. If you specify the URI of a table that does not exist, Data Labeling Service creates a table at the URI with the correct schema when you create your EvaluationJob. If you specify the URI of a table that already exists, it must have the correct schema. Provide the table URI in the following format: "bq://{your_project_id}/ {your_dataset_name}/{your_table_name}" Learn more.

    GoogleCloudDatalabelingV1beta1ClassificationMetadataResponse

    IsMultiLabel bool
    Whether the classification task is multi-label or not.
    IsMultiLabel bool
    Whether the classification task is multi-label or not.
    isMultiLabel Boolean
    Whether the classification task is multi-label or not.
    isMultiLabel boolean
    Whether the classification task is multi-label or not.
    is_multi_label bool
    Whether the classification task is multi-label or not.
    isMultiLabel Boolean
    Whether the classification task is multi-label or not.

    GoogleCloudDatalabelingV1beta1GcsSourceResponse

    InputUri string
    The input URI of source file. This must be a Cloud Storage path (gs://...).
    MimeType string
    The format of the source file. Only "text/csv" is supported.
    InputUri string
    The input URI of source file. This must be a Cloud Storage path (gs://...).
    MimeType string
    The format of the source file. Only "text/csv" is supported.
    inputUri String
    The input URI of source file. This must be a Cloud Storage path (gs://...).
    mimeType String
    The format of the source file. Only "text/csv" is supported.
    inputUri string
    The input URI of source file. This must be a Cloud Storage path (gs://...).
    mimeType string
    The format of the source file. Only "text/csv" is supported.
    input_uri str
    The input URI of source file. This must be a Cloud Storage path (gs://...).
    mime_type str
    The format of the source file. Only "text/csv" is supported.
    inputUri String
    The input URI of source file. This must be a Cloud Storage path (gs://...).
    mimeType String
    The format of the source file. Only "text/csv" is supported.

    GoogleCloudDatalabelingV1beta1InputConfigResponse

    AnnotationType string
    Optional. The type of annotation to be performed on this data. You must specify this field if you are using this InputConfig in an EvaluationJob.
    BigquerySource Pulumi.GoogleNative.DataLabeling.V1Beta1.Inputs.GoogleCloudDatalabelingV1beta1BigQuerySourceResponse
    Source located in BigQuery. You must specify this field if you are using this InputConfig in an EvaluationJob.
    ClassificationMetadata Pulumi.GoogleNative.DataLabeling.V1Beta1.Inputs.GoogleCloudDatalabelingV1beta1ClassificationMetadataResponse
    Optional. Metadata about annotations for the input. You must specify this field if you are using this InputConfig in an EvaluationJob for a model version that performs classification.
    DataType string
    Data type must be specifed when user tries to import data.
    GcsSource Pulumi.GoogleNative.DataLabeling.V1Beta1.Inputs.GoogleCloudDatalabelingV1beta1GcsSourceResponse
    Source located in Cloud Storage.
    TextMetadata Pulumi.GoogleNative.DataLabeling.V1Beta1.Inputs.GoogleCloudDatalabelingV1beta1TextMetadataResponse
    Required for text import, as language code must be specified.
    AnnotationType string
    Optional. The type of annotation to be performed on this data. You must specify this field if you are using this InputConfig in an EvaluationJob.
    BigquerySource GoogleCloudDatalabelingV1beta1BigQuerySourceResponse
    Source located in BigQuery. You must specify this field if you are using this InputConfig in an EvaluationJob.
    ClassificationMetadata GoogleCloudDatalabelingV1beta1ClassificationMetadataResponse
    Optional. Metadata about annotations for the input. You must specify this field if you are using this InputConfig in an EvaluationJob for a model version that performs classification.
    DataType string
    Data type must be specifed when user tries to import data.
    GcsSource GoogleCloudDatalabelingV1beta1GcsSourceResponse
    Source located in Cloud Storage.
    TextMetadata GoogleCloudDatalabelingV1beta1TextMetadataResponse
    Required for text import, as language code must be specified.
    annotationType String
    Optional. The type of annotation to be performed on this data. You must specify this field if you are using this InputConfig in an EvaluationJob.
    bigquerySource GoogleCloudDatalabelingV1beta1BigQuerySourceResponse
    Source located in BigQuery. You must specify this field if you are using this InputConfig in an EvaluationJob.
    classificationMetadata GoogleCloudDatalabelingV1beta1ClassificationMetadataResponse
    Optional. Metadata about annotations for the input. You must specify this field if you are using this InputConfig in an EvaluationJob for a model version that performs classification.
    dataType String
    Data type must be specifed when user tries to import data.
    gcsSource GoogleCloudDatalabelingV1beta1GcsSourceResponse
    Source located in Cloud Storage.
    textMetadata GoogleCloudDatalabelingV1beta1TextMetadataResponse
    Required for text import, as language code must be specified.
    annotationType string
    Optional. The type of annotation to be performed on this data. You must specify this field if you are using this InputConfig in an EvaluationJob.
    bigquerySource GoogleCloudDatalabelingV1beta1BigQuerySourceResponse
    Source located in BigQuery. You must specify this field if you are using this InputConfig in an EvaluationJob.
    classificationMetadata GoogleCloudDatalabelingV1beta1ClassificationMetadataResponse
    Optional. Metadata about annotations for the input. You must specify this field if you are using this InputConfig in an EvaluationJob for a model version that performs classification.
    dataType string
    Data type must be specifed when user tries to import data.
    gcsSource GoogleCloudDatalabelingV1beta1GcsSourceResponse
    Source located in Cloud Storage.
    textMetadata GoogleCloudDatalabelingV1beta1TextMetadataResponse
    Required for text import, as language code must be specified.
    annotation_type str
    Optional. The type of annotation to be performed on this data. You must specify this field if you are using this InputConfig in an EvaluationJob.
    bigquery_source GoogleCloudDatalabelingV1beta1BigQuerySourceResponse
    Source located in BigQuery. You must specify this field if you are using this InputConfig in an EvaluationJob.
    classification_metadata GoogleCloudDatalabelingV1beta1ClassificationMetadataResponse
    Optional. Metadata about annotations for the input. You must specify this field if you are using this InputConfig in an EvaluationJob for a model version that performs classification.
    data_type str
    Data type must be specifed when user tries to import data.
    gcs_source GoogleCloudDatalabelingV1beta1GcsSourceResponse
    Source located in Cloud Storage.
    text_metadata GoogleCloudDatalabelingV1beta1TextMetadataResponse
    Required for text import, as language code must be specified.
    annotationType String
    Optional. The type of annotation to be performed on this data. You must specify this field if you are using this InputConfig in an EvaluationJob.
    bigquerySource Property Map
    Source located in BigQuery. You must specify this field if you are using this InputConfig in an EvaluationJob.
    classificationMetadata Property Map
    Optional. Metadata about annotations for the input. You must specify this field if you are using this InputConfig in an EvaluationJob for a model version that performs classification.
    dataType String
    Data type must be specifed when user tries to import data.
    gcsSource Property Map
    Source located in Cloud Storage.
    textMetadata Property Map
    Required for text import, as language code must be specified.

    GoogleCloudDatalabelingV1beta1TextMetadataResponse

    LanguageCode string
    The language of this text, as a BCP-47. Default value is en-US.
    LanguageCode string
    The language of this text, as a BCP-47. Default value is en-US.
    languageCode String
    The language of this text, as a BCP-47. Default value is en-US.
    languageCode string
    The language of this text, as a BCP-47. Default value is en-US.
    language_code str
    The language of this text, as a BCP-47. Default value is en-US.
    languageCode String
    The language of this text, as a BCP-47. Default value is en-US.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi