Class: Algolia::Search::SearchSynonymsParams

Inherits:
Object
  • Object
show all
Defined in:
lib/algolia/models/search/search_synonyms_params.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchSynonymsParams

Initializes the object

Parameters:

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

    Model attributes in the form of hash



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 76

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    raise(
      ArgumentError,
      "The input argument (attributes) must be a hash in `Algolia::SearchSynonymsParams` initialize method"
    )
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      raise(
        ArgumentError,
        "`#{k}` is not a valid attribute in `Algolia::SearchSynonymsParams`. Please check the name to make sure it's valid. List of attributes: " +
          self.class.attribute_map.keys.inspect
      )
    end

    h[k.to_sym] = v
  }

  if attributes.key?(:query)
    self.query = attributes[:query]
  end

  if attributes.key?(:type)
    self.type = attributes[:type]
  end

  if attributes.key?(:page)
    self.page = attributes[:page]
  end

  if attributes.key?(:hits_per_page)
    self.hits_per_page = attributes[:hits_per_page]
  end
end

Instance Attribute Details

#hits_per_page ⇒ Object

Number of hits per page.



18
19
20
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 18

def hits_per_page
  @hits_per_page
end

#page ⇒ Object

Page of search results to retrieve.



15
16
17
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 15

def page
  @page
end

#query ⇒ Object

Search query.



10
11
12
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 10

def query
  @query
end

#type ⇒ Object

Returns the value of attribute type.



12
13
14
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 12

def type
  @type
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 199

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end

  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
    # model
  else
    # models (e.g. Pet) or oneOf
    klass = Algolia::Search.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass
      .build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



53
54
55
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 53

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 43

def self.attribute_map
  {
    :query => :query,
    :type => :type,
    :page => :page,
    :hits_per_page => :hitsPerPage
  }
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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 172

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  types_mapping.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash[key.to_sym] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash[key.to_sym] = attributes[attribute_map[key]].map { |v|
          _deserialize(::Regexp.last_match(1), v)
        }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
    end
  end

  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



68
69
70
71
72
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 68

def self.openapi_nullable
  Set.new(
    []
  )
end

.types_mapping ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 58

def self.types_mapping
  {
    :query => :"String",
    :type => :"SynonymType",
    :page => :"Integer",
    :hits_per_page => :"Integer"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



148
149
150
151
152
153
154
155
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 148

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    query == other.query &&
    type == other.type &&
    page == other.page &&
    hits_per_page == other.hits_per_page
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 278

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to?(:to_hash)
    value.to_hash
  else
    value
  end
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


159
160
161
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 159

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



165
166
167
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 165

def hash
  [query, type, page, hits_per_page].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



249
250
251
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 249

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 259

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end

  hash
end

#to_json(*_args) ⇒ Object 



253
254
255
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 253

def to_json(*_args)
  to_hash.to_json
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



243
244
245
 
# File 'lib/algolia/models/search/search_synonyms_params.rb', line 243

def to_s
  to_hash.to_s
end