annotation_spec_sets

Creates, updates, deletes, gets or lists an annotation_spec_sets resource.

Overview

Name	annotation_spec_sets
Type	Resource
Id	google.datalabeling.annotation_spec_sets

Fields

The following fields are returned by SELECT queries:

projects_annotation_spec_sets_get

Successful response

Name	Datatype	Description
name	string	Output only. The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
annotationSpecs	array	Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
blockingResources	array	Output only. 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	Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.

projects_annotation_spec_sets_list

Successful response

Name	Datatype	Description
name	string	Output only. The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}"
annotationSpecs	array	Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task.
blockingResources	array	Output only. 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	Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_annotation_spec_sets_get	select	projectsId, annotationSpecSetsId		Gets an annotation spec set by resource name.
projects_annotation_spec_sets_list	select	projectsId	filter, pageSize, pageToken	Lists annotation spec sets for a project. Pagination is supported.
projects_annotation_spec_sets_create	insert	projectsId		Creates an annotation spec set by providing a set of labels.
projects_annotation_spec_sets_delete	delete	projectsId, annotationSpecSetsId		Deletes an annotation spec set by resource name.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
annotationSpecSetsId	string
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_annotation_spec_sets_get

Gets an annotation spec set by resource name.

SELECT
name,
annotationSpecs,
blockingResources,
description,
displayName
FROM google.datalabeling.annotation_spec_sets
WHERE projectsId = '{{ projectsId }}' -- required
AND annotationSpecSetsId = '{{ annotationSpecSetsId }}' -- required;

projects_annotation_spec_sets_list

Lists annotation spec sets for a project. Pagination is supported.

SELECT
name,
annotationSpecs,
blockingResources,
description,
displayName
FROM google.datalabeling.annotation_spec_sets
WHERE projectsId = '{{ projectsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

projects_annotation_spec_sets_create

Creates an annotation spec set by providing a set of labels.

INSERT INTO google.datalabeling.annotation_spec_sets (
data__annotationSpecSet,
projectsId
)
SELECT 
'{{ annotationSpecSet }}',
'{{ projectsId }}'
RETURNING
name,
annotationSpecs,
blockingResources,
description,
displayName
;

Manifest

# Description fields are for documentation purposes
- name: annotation_spec_sets
  props:
    - name: projectsId
      value: string
      description: Required parameter for the annotation_spec_sets resource.
    - name: annotationSpecSet
      value: object
      description: >
        Required. Annotation spec set to create. Annotation specs must be included. Only one annotation spec will be accepted for annotation specs with same display_name.
        

DELETE examples

projects_annotation_spec_sets_delete

Deletes an annotation spec set by resource name.

DELETE FROM google.datalabeling.annotation_spec_sets
WHERE projectsId = '{{ projectsId }}' --required
AND annotationSpecSetsId = '{{ annotationSpecSetsId }}' --required;