Class: Algolia::Search::SearchDictionaryEntriesResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchDictionaryEntriesResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/algolia/models/search/search_dictionary_entries_response.rb', line 50

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    raise(
      ArgumentError,
      "The input argument (attributes) must be a hash in `Algolia::SearchDictionaryEntriesResponse` 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::SearchDictionaryEntriesResponse`. 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?(:hits)
    if (value = attributes[:hits]).is_a?(Array)
      self.hits = value
    end
  else
    self.hits = nil
  end

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

  if attributes.key?(:nb_hits)
    self.nb_hits = attributes[:nb_hits]
  else
    self.nb_hits = nil
  end

  if attributes.key?(:nb_pages)
    self.nb_pages = attributes[:nb_pages]
  else
    self.nb_pages = nil
  end
end

Instance Attribute Details

#hits ⇒ Object

Dictionary entries matching the search criteria.



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

def hits
  @hits
end

#nb_hits ⇒ Object

Number of results (hits).



16
17
18
 
# File 'lib/algolia/models/search/search_dictionary_entries_response.rb', line 16

def nb_hits
  @nb_hits
end

#nb_pages ⇒ Object

Number of pages of results.



19
20
21
 
# File 'lib/algolia/models/search/search_dictionary_entries_response.rb', line 19

def nb_pages
  @nb_pages
end

#page ⇒ Object

Requested page of the API response. Algolia uses ‘page` and `hitsPerPage` to control how search results are displayed ([paginated](www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (hits) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.



13
14
15
 
# File 'lib/algolia/models/search/search_dictionary_entries_response.rb', line 13

def page
  @page
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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/algolia/models/search/search_dictionary_entries_response.rb', line 151

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

.attribute_map ⇒ Object

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



22
23
24
25
26
27
28
29
 
# File 'lib/algolia/models/search/search_dictionary_entries_response.rb', line 22

def self.attribute_map
  {
    :hits => :hits,
    :page => :page,
    :nb_hits => :nbHits,
    :nb_pages => :nbPages
  }
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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/algolia/models/search/search_dictionary_entries_response.rb', line 124

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



42
43
44
45
46
 
# File 'lib/algolia/models/search/search_dictionary_entries_response.rb', line 42

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

.types_mapping ⇒ Object

Attribute type mapping.



32
33
34
35
36
37
38
39
 
# File 'lib/algolia/models/search/search_dictionary_entries_response.rb', line 32

def self.types_mapping
  {
    :hits => :"Array<DictionaryEntry>",
    :page => :"Integer",
    :nb_hits => :"Integer",
    :nb_pages => :"Integer"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



100
101
102
103
104
105
106
107
 
# File 'lib/algolia/models/search/search_dictionary_entries_response.rb', line 100

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    hits == other.hits &&
    page == other.page &&
    nb_hits == other.nb_hits &&
    nb_pages == other.nb_pages
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



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/algolia/models/search/search_dictionary_entries_response.rb', line 230

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


111
112
113
 
# File 'lib/algolia/models/search/search_dictionary_entries_response.rb', line 111

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



117
118
119
 
# File 'lib/algolia/models/search/search_dictionary_entries_response.rb', line 117

def hash
  [hits, page, nb_hits, nb_pages].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



201
202
203
 
# File 'lib/algolia/models/search/search_dictionary_entries_response.rb', line 201

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/algolia/models/search/search_dictionary_entries_response.rb', line 211

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 



205
206
207
 
# File 'lib/algolia/models/search/search_dictionary_entries_response.rb', line 205

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



195
196
197
 
# File 'lib/algolia/models/search/search_dictionary_entries_response.rb', line 195

def to_s
  to_hash.to_s
end