Class: Google::Apis::DatalabelingV1beta1::GoogleCloudDatalabelingV1beta1AnnotatedDataset

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

AnnotatedDataset is a set holding annotations for data in a Dataset. Each labeling task will generate an AnnotatedDataset under the Dataset that the task is requested for.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatalabelingV1beta1AnnotatedDataset

Returns a new instance of GoogleCloudDatalabelingV1beta1AnnotatedDataset.



795
796
797
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 795

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

Instance Attribute Details

#annotation_source ⇒ String

Output only. Source of the annotation. Corresponds to the JSON property annotationSource

Returns:

  • (String) 


736
737
738
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 736

def annotation_source
  @annotation_source
end

#annotation_type ⇒ String

Output only. Type of the annotation. It is specified when starting labeling task. Corresponds to the JSON property annotationType

Returns:

  • (String) 


742
743
744
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 742

def annotation_type
  @annotation_type
end

#blocking_resources ⇒ Array<String>

Output only. The names of any related resources that are blocking changes to the annotated dataset. Corresponds to the JSON property blockingResources

Returns:

  • (Array<String>) 


748
749
750
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 748

def blocking_resources
  @blocking_resources
end

#completed_example_count ⇒ Fixnum

Output only. Number of examples that have annotation in the annotated dataset. Corresponds to the JSON property completedExampleCount

Returns:

  • (Fixnum) 


753
754
755
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 753

def completed_example_count
  @completed_example_count
end

#create_time ⇒ String

Output only. Time the AnnotatedDataset was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


758
759
760
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 758

def create_time
  @create_time
end

#description ⇒ String

Output only. The description of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 10000 characters. Corresponds to the JSON property description

Returns:

  • (String) 


765
766
767
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 765

def description
  @description
end

#display_name ⇒ String

Output only. The display name of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 64 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


772
773
774
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 772

def display_name
  @display_name
end

#example_count ⇒ Fixnum

Output only. Number of examples in the annotated dataset. Corresponds to the JSON property exampleCount

Returns:

  • (Fixnum) 


777
778
779
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 777

def example_count
  @example_count
end

#label_stats ⇒ Google::Apis::DatalabelingV1beta1::GoogleCloudDatalabelingV1beta1LabelStats

Statistics about annotation specs. Corresponds to the JSON property labelStats

Returns:



782
783
784
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 782

def label_stats
  @label_stats
end

#metadata ⇒ Google::Apis::DatalabelingV1beta1::GoogleCloudDatalabelingV1beta1AnnotatedDatasetMetadata

Metadata on AnnotatedDataset. Corresponds to the JSON property metadata

Returns:



787
788
789
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 787

def metadata
  @metadata
end

#name ⇒ String

Output only. AnnotatedDataset resource name in format of: projects/project_id /datasets/dataset_id/annotatedDatasets/ annotated_dataset_id Corresponds to the JSON property name

Returns:

  • (String) 


793
794
795
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 793

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'generated/google/apis/datalabeling_v1beta1/classes.rb', line 800

def update!(**args)
  @annotation_source = args[:annotation_source] if args.key?(:annotation_source)
  @annotation_type = args[:annotation_type] if args.key?(:annotation_type)
  @blocking_resources = args[:blocking_resources] if args.key?(:blocking_resources)
  @completed_example_count = args[:completed_example_count] if args.key?(:completed_example_count)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @example_count = args[:example_count] if args.key?(:example_count)
  @label_stats = args[:label_stats] if args.key?(:label_stats)
  @metadata = args[:metadata] if args.key?(:metadata)
  @name = args[:name] if args.key?(:name)
end