Class: OCI::DataLabelingServiceDataplane::Models::AnnotationAnalyticsAggregationCollection

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_labeling_service_dataplane/models/annotation_analytics_aggregation_collection.rb

Overview

Aggregation entities are required by the API consistency guidelines for API Consistency Guidelines#AnalyticsAPIs. These are used to summarize annotations for a given dataset and will be used to populate UI elements. Aggregations need to have the fields that identify the exact scope that they're summarizing. Any filters applied to the list API, have to show up in the aggregation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnnotationAnalyticsAggregationCollection

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



40
41
42
43
44
45
46
47
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation_analytics_aggregation_collection.rb', line 40

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.items = attributes[:'items'] if attributes[:'items']
end

Instance Attribute Details

#items ⇒ Array<OCI::DataLabelingServiceDataplane::Models::AnnotationAnalyticsAggregation>

[Required] The list of annotation entities.

Returns:



13
14
15
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation_analytics_aggregation_collection.rb', line 13

def items
  @items
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



16
17
18
19
20
21
22
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation_analytics_aggregation_collection.rb', line 16

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'items': :'items'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



25
26
27
28
29
30
31
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation_analytics_aggregation_collection.rb', line 25

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'items': :'Array<OCI::DataLabelingServiceDataplane::Models::AnnotationAnalyticsAggregation>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



56
57
58
59
60
61
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation_analytics_aggregation_collection.rb', line 56

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    items == other.items
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation_analytics_aggregation_collection.rb', line 86

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


66
67
68
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation_analytics_aggregation_collection.rb', line 66

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



75
76
77
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation_analytics_aggregation_collection.rb', line 75

def hash
  [items].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation_analytics_aggregation_collection.rb', line 119

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



113
114
115
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation_analytics_aggregation_collection.rb', line 113

def to_s
  to_hash.to_s
end