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

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
pulumi/pulumi-google-native

google-native.datalabeling/v1beta1.getAnnotationSpecSet

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
pulumi/pulumi-google-native

    Gets an annotation spec set by resource name.

    Using getAnnotationSpecSet

    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 getAnnotationSpecSet(args: GetAnnotationSpecSetArgs, opts?: InvokeOptions): Promise<GetAnnotationSpecSetResult>
function getAnnotationSpecSetOutput(args: GetAnnotationSpecSetOutputArgs, opts?: InvokeOptions): Output<GetAnnotationSpecSetResult>
    def get_annotation_spec_set(annotation_spec_set_id: Optional[str] = None,
                            project: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetAnnotationSpecSetResult
def get_annotation_spec_set_output(annotation_spec_set_id: Optional[pulumi.Input[str]] = None,
                            project: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetAnnotationSpecSetResult]
    func LookupAnnotationSpecSet(ctx *Context, args *LookupAnnotationSpecSetArgs, opts ...InvokeOption) (*LookupAnnotationSpecSetResult, error)
func LookupAnnotationSpecSetOutput(ctx *Context, args *LookupAnnotationSpecSetOutputArgs, opts ...InvokeOption) LookupAnnotationSpecSetResultOutput

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

    public static class GetAnnotationSpecSet 
{
    public static Task<GetAnnotationSpecSetResult> InvokeAsync(GetAnnotationSpecSetArgs args, InvokeOptions? opts = null)
    public static Output<GetAnnotationSpecSetResult> Invoke(GetAnnotationSpecSetInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAnnotationSpecSetResult> getAnnotationSpecSet(GetAnnotationSpecSetArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:datalabeling/v1beta1:getAnnotationSpecSet
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getAnnotationSpecSet Result

    The following output properties are available:

    AnnotationSpecs List<Pulumi.GoogleNative.DataLabeling.V1Beta1.Outputs.GoogleCloudDatalabelingV1beta1AnnotationSpecResponse>
    The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
    BlockingResources List<string>
    The names of any related resources that are blocking changes to the annotation spec set.
    Description string
    Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
    DisplayName string
    The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
    Name string
    The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
    AnnotationSpecs []GoogleCloudDatalabelingV1beta1AnnotationSpecResponse
    The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
    BlockingResources []string
    The names of any related resources that are blocking changes to the annotation spec set.
    Description string
    Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
    DisplayName string
    The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
    Name string
    The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
    annotationSpecs List<GoogleCloudDatalabelingV1beta1AnnotationSpecResponse>
    The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
    blockingResources List<String>
    The names of any related resources that are blocking changes to the annotation spec set.
    description String
    Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
    displayName String
    The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
    name String
    The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
    annotationSpecs GoogleCloudDatalabelingV1beta1AnnotationSpecResponse[]
    The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
    blockingResources string[]
    The names of any related resources that are blocking changes to the annotation spec set.
    description string
    Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
    displayName string
    The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
    name string
    The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
    annotation_specs Sequence[GoogleCloudDatalabelingV1beta1AnnotationSpecResponse]
    The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
    blocking_resources Sequence[str]
    The names of any related resources that are blocking changes to the annotation spec set.
    description str
    Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
    display_name str
    The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
    name str
    The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
    annotationSpecs List<Property Map>
    The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
    blockingResources List<String>
    The names of any related resources that are blocking changes to the annotation spec set.
    description String
    Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
    displayName String
    The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
    name String
    The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"

    Supporting Types

    GoogleCloudDatalabelingV1beta1AnnotationSpecResponse

    Description string
    Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
    DisplayName string
    The display name of the AnnotationSpec. Maximum of 64 characters.
    Index int
    This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes dog and cat, might contain one AnnotationSpec with { display_name: "dog", index: 0 } and one AnnotationSpec with { display_name: "cat", index: 1 }. This is especially useful for model training as it encodes the string labels into numeric values.
    Description string
    Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
    DisplayName string
    The display name of the AnnotationSpec. Maximum of 64 characters.
    Index int
    This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes dog and cat, might contain one AnnotationSpec with { display_name: "dog", index: 0 } and one AnnotationSpec with { display_name: "cat", index: 1 }. This is especially useful for model training as it encodes the string labels into numeric values.
    description String
    Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
    displayName String
    The display name of the AnnotationSpec. Maximum of 64 characters.
    index Integer
    This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes dog and cat, might contain one AnnotationSpec with { display_name: "dog", index: 0 } and one AnnotationSpec with { display_name: "cat", index: 1 }. This is especially useful for model training as it encodes the string labels into numeric values.
    description string
    Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
    displayName string
    The display name of the AnnotationSpec. Maximum of 64 characters.
    index number
    This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes dog and cat, might contain one AnnotationSpec with { display_name: "dog", index: 0 } and one AnnotationSpec with { display_name: "cat", index: 1 }. This is especially useful for model training as it encodes the string labels into numeric values.
    description str
    Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
    display_name str
    The display name of the AnnotationSpec. Maximum of 64 characters.
    index int
    This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes dog and cat, might contain one AnnotationSpec with { display_name: "dog", index: 0 } and one AnnotationSpec with { display_name: "cat", index: 1 }. This is especially useful for model training as it encodes the string labels into numeric values.
    description String
    Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.
    displayName String
    The display name of the AnnotationSpec. Maximum of 64 characters.
    index Number
    This is the integer index of the AnnotationSpec. The index for the whole AnnotationSpecSet is sequential starting from 0. For example, an AnnotationSpecSet with classes dog and cat, might contain one AnnotationSpec with { display_name: "dog", index: 0 } and one AnnotationSpec with { display_name: "cat", index: 1 }. This is especially useful for model training as it encodes the string labels into numeric values.

    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
    pulumi/pulumi-google-native