Class: Google::Apis::DatalabelingV1beta1::GoogleCloudDatalabelingV1beta1AnnotationSpecSet

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/datalabeling_v1beta1/classes.rb,
generated/google/apis/datalabeling_v1beta1/representations.rb,
generated/google/apis/datalabeling_v1beta1/representations.rb

Overview

An AnnotationSpecSet is a collection of label definitions. For example, in image classification tasks, you define a set of possible labels for images as an AnnotationSpecSet. An AnnotationSpecSet is immutable upon creation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatalabelingV1beta1AnnotationSpecSet

Returns a new instance of GoogleCloudDatalabelingV1beta1AnnotationSpecSet.



1042
1043
1044
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1042

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#annotation_specsArray<Google::Apis::DatalabelingV1beta1::GoogleCloudDatalabelingV1beta1AnnotationSpec>

Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task. Corresponds to the JSON property annotationSpecs



1016
1017
1018
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1016

def annotation_specs
  @annotation_specs
end

#blocking_resourcesArray<String>

Output only. The names of any related resources that are blocking changes to the annotation spec set. Corresponds to the JSON property blockingResources

Returns:

  • (Array<String>)


1022
1023
1024
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1022

def blocking_resources
  @blocking_resources
end

#descriptionString

Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long. Corresponds to the JSON property description

Returns:

  • (String)


1028
1029
1030
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1028

def description
  @description
end

#display_nameString

Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters. Corresponds to the JSON property displayName

Returns:

  • (String)


1034
1035
1036
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1034

def display_name
  @display_name
end

#nameString

Output only. The AnnotationSpecSet resource name in the following format: " projects/project_id/annotationSpecSets/annotation_spec_set_id" Corresponds to the JSON property name

Returns:

  • (String)


1040
1041
1042
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1040

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1047
1048
1049
1050
1051
1052
1053
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 1047

def update!(**args)
  @annotation_specs = args[:annotation_specs] if args.key?(:annotation_specs)
  @blocking_resources = args[:blocking_resources] if args.key?(:blocking_resources)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @name = args[:name] if args.key?(:name)
end