Class: OCI::DataCatalog::Models::FacetedSearchAggregation

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_catalog/models/faceted_search_aggregation.rb

Overview

Aggregation/facets on properties of data object.

Constant Summary collapse

PROPERTY_TYPE_ENUM =
[
  PROPERTY_TYPE_CUSTOM_PROPERTY = 'CUSTOM_PROPERTY'.freeze,
  PROPERTY_TYPE_DEFAULT_PROPERTY = 'DEFAULT_PROPERTY'.freeze,
  PROPERTY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FacetedSearchAggregation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String)

    The value to assign to the #type property

  • :aggregation (Hash<String, Integer>)

    The value to assign to the #aggregation property

  • :data_type (String)

    The value to assign to the #data_type property

  • :property_type (String)

    The value to assign to the #property_type property



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/oci/data_catalog/models/faceted_search_aggregation.rb', line 70

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.type = attributes[:'type'] if attributes[:'type']

  self.aggregation = attributes[:'aggregation'] if attributes[:'aggregation']

  self.data_type = attributes[:'dataType'] if attributes[:'dataType']

  raise 'You cannot provide both :dataType and :data_type' if attributes.key?(:'dataType') && attributes.key?(:'data_type')

  self.data_type = attributes[:'data_type'] if attributes[:'data_type']

  self.property_type = attributes[:'propertyType'] if attributes[:'propertyType']

  raise 'You cannot provide both :propertyType and :property_type' if attributes.key?(:'propertyType') && attributes.key?(:'property_type')

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

Instance Attribute Details

#aggregationHash<String, Integer>

Count of number of data objects having property.

Returns:

  • (Hash<String, Integer>)


23
24
25
# File 'lib/oci/data_catalog/models/faceted_search_aggregation.rb', line 23

def aggregation
  @aggregation
end

#data_typeString

Data type of object property.

Returns:

  • (String)


27
28
29
# File 'lib/oci/data_catalog/models/faceted_search_aggregation.rb', line 27

def data_type
  @data_type
end

#property_typeString

Type of property that indicates if it was defined by the user or system. CUSTOM_PROPERTY is defined by the user on a data object. DEFAULT_PROPERTY is defined by the system on a data object.

Returns:

  • (String)


34
35
36
# File 'lib/oci/data_catalog/models/faceted_search_aggregation.rb', line 34

def property_type
  @property_type
end

#typeString

Name of data object property

Returns:

  • (String)


19
20
21
# File 'lib/oci/data_catalog/models/faceted_search_aggregation.rb', line 19

def type
  @type
end

Class Method Details

.attribute_mapObject

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



37
38
39
40
41
42
43
44
45
46
# File 'lib/oci/data_catalog/models/faceted_search_aggregation.rb', line 37

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'aggregation': :'aggregation',
    'data_type': :'dataType',
    'property_type': :'propertyType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
# File 'lib/oci/data_catalog/models/faceted_search_aggregation.rb', line 49

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'aggregation': :'Hash<String, Integer>',
    'data_type': :'String',
    'property_type': :'String'
    # 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



113
114
115
116
117
118
119
120
121
# File 'lib/oci/data_catalog/models/faceted_search_aggregation.rb', line 113

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

  self.class == other.class &&
    type == other.type &&
    aggregation == other.aggregation &&
    data_type == other.data_type &&
    property_type == other.property_type
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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/oci/data_catalog/models/faceted_search_aggregation.rb', line 146

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


126
127
128
# File 'lib/oci/data_catalog/models/faceted_search_aggregation.rb', line 126

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



135
136
137
# File 'lib/oci/data_catalog/models/faceted_search_aggregation.rb', line 135

def hash
  [type, aggregation, data_type, property_type].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



179
180
181
182
183
184
185
186
187
188
# File 'lib/oci/data_catalog/models/faceted_search_aggregation.rb', line 179

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



173
174
175
# File 'lib/oci/data_catalog/models/faceted_search_aggregation.rb', line 173

def to_s
  to_hash.to_s
end