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

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.AnnotationSpecSet

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

    Creates an annotation spec set by providing a set of labels. Auto-naming is currently not supported for this resource.

    Create AnnotationSpecSet Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AnnotationSpecSet(name: string, args: AnnotationSpecSetArgs, opts?: CustomResourceOptions);
    @overload
def AnnotationSpecSet(resource_name: str,
                      args: AnnotationSpecSetArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def AnnotationSpecSet(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      annotation_specs: Optional[Sequence[GoogleCloudDatalabelingV1beta1AnnotationSpecArgs]] = None,
                      display_name: Optional[str] = None,
                      description: Optional[str] = None,
                      project: Optional[str] = None)
    func NewAnnotationSpecSet(ctx *Context, name string, args AnnotationSpecSetArgs, opts ...ResourceOption) (*AnnotationSpecSet, error)
    public AnnotationSpecSet(string name, AnnotationSpecSetArgs args, CustomResourceOptions? opts = null)
    public AnnotationSpecSet(String name, AnnotationSpecSetArgs args)
public AnnotationSpecSet(String name, AnnotationSpecSetArgs args, CustomResourceOptions options)

    type: google-native:datalabeling/v1beta1:AnnotationSpecSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AnnotationSpecSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AnnotationSpecSetArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AnnotationSpecSetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AnnotationSpecSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AnnotationSpecSetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var annotationSpecSetResource = new GoogleNative.DataLabeling.V1Beta1.AnnotationSpecSet("annotationSpecSetResource", new()
{
    AnnotationSpecs = new[]
    {
        new GoogleNative.DataLabeling.V1Beta1.Inputs.GoogleCloudDatalabelingV1beta1AnnotationSpecArgs
        {
            DisplayName = "string",
            Description = "string",
        },
    },
    DisplayName = "string",
    Description = "string",
    Project = "string",
});

    example, err := datalabeling.NewAnnotationSpecSet(ctx, "annotationSpecSetResource", &datalabeling.AnnotationSpecSetArgs{
AnnotationSpecs: datalabeling.GoogleCloudDatalabelingV1beta1AnnotationSpecArray{
&datalabeling.GoogleCloudDatalabelingV1beta1AnnotationSpecArgs{
DisplayName: pulumi.String("string"),
Description: pulumi.String("string"),
},
},
DisplayName: pulumi.String("string"),
Description: pulumi.String("string"),
Project: pulumi.String("string"),
})

    var annotationSpecSetResource = new AnnotationSpecSet("annotationSpecSetResource", AnnotationSpecSetArgs.builder()
    .annotationSpecs(GoogleCloudDatalabelingV1beta1AnnotationSpecArgs.builder()
        .displayName("string")
        .description("string")
        .build())
    .displayName("string")
    .description("string")
    .project("string")
    .build());

    annotation_spec_set_resource = google_native.datalabeling.v1beta1.AnnotationSpecSet("annotationSpecSetResource",
    annotation_specs=[google_native.datalabeling.v1beta1.GoogleCloudDatalabelingV1beta1AnnotationSpecArgs(
        display_name="string",
        description="string",
    )],
    display_name="string",
    description="string",
    project="string")

    const annotationSpecSetResource = new google_native.datalabeling.v1beta1.AnnotationSpecSet("annotationSpecSetResource", {
    annotationSpecs: [{
        displayName: "string",
        description: "string",
    }],
    displayName: "string",
    description: "string",
    project: "string",
});

    type: google-native:datalabeling/v1beta1:AnnotationSpecSet
properties:
    annotationSpecs:
        - description: string
          displayName: string
    description: string
    displayName: string
    project: string

    AnnotationSpecSet Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AnnotationSpecSet resource accepts the following input properties:

    AnnotationSpecs List<Pulumi.GoogleNative.DataLabeling.V1Beta1.Inputs.GoogleCloudDatalabelingV1beta1AnnotationSpec>
    The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
    DisplayName string
    The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
    Description string
    Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
    Project string
    AnnotationSpecs []GoogleCloudDatalabelingV1beta1AnnotationSpecArgs
    The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
    DisplayName string
    The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
    Description string
    Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
    Project string
    annotationSpecs List<GoogleCloudDatalabelingV1beta1AnnotationSpec>
    The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
    displayName String
    The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
    description String
    Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
    project String
    annotationSpecs GoogleCloudDatalabelingV1beta1AnnotationSpec[]
    The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
    displayName string
    The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
    description string
    Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
    project string
    annotation_specs Sequence[GoogleCloudDatalabelingV1beta1AnnotationSpecArgs]
    The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
    display_name str
    The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
    description str
    Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
    project str
    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.
    displayName String
    The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.
    description String
    Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long.
    project String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AnnotationSpecSet resource produces the following output properties:

    BlockingResources List<string>
    The names of any related resources that are blocking changes to the annotation spec set.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
    BlockingResources []string
    The names of any related resources that are blocking changes to the annotation spec set.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
    blockingResources List<String>
    The names of any related resources that are blocking changes to the annotation spec set.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
    blockingResources string[]
    The names of any related resources that are blocking changes to the annotation spec set.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
    blocking_resources Sequence[str]
    The names of any related resources that are blocking changes to the annotation spec set.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
    blockingResources List<String>
    The names of any related resources that are blocking changes to the annotation spec set.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"

    Supporting Types

    GoogleCloudDatalabelingV1beta1AnnotationSpec, GoogleCloudDatalabelingV1beta1AnnotationSpecArgs

    DisplayName string
    The display name of the AnnotationSpec. Maximum of 64 characters.
    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.
    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.
    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.
    description string
    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.
    description str
    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.
    description String
    Optional. User-provided description of the annotation specification. The description can be up to 10,000 characters long.

    GoogleCloudDatalabelingV1beta1AnnotationSpecResponse, GoogleCloudDatalabelingV1beta1AnnotationSpecResponseArgs

    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