Class: Algolia::Search::SearchRulesParams

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

Overview

Rules search parameters.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchRulesParams

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/algolia/models/search/search_rules_params.rb', line 67

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

  if attributes.key?(:context)
    self.context = attributes[:context]
  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

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

Instance Attribute Details

#anchoring ⇒ Object

Returns the value of attribute anchoring.



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

def anchoring
  @anchoring
end

#context ⇒ Object

Only return rules that match the context (exact match).



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

def context
  @context
end

#enabled ⇒ Object

If ‘true`, return only enabled rules. If `false`, return only inactive rules. By default, all rules are returned.



25
26
27
 
# File 'lib/algolia/models/search/search_rules_params.rb', line 25

def enabled
  @enabled
end

#hits_per_page ⇒ Object

Maximum number of hits per page. 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.



22
23
24
 
# File 'lib/algolia/models/search/search_rules_params.rb', line 22

def hits_per_page
  @hits_per_page
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.



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

def page
  @page
end

#query ⇒ Object

Search query for rules.



11
12
13
 
# File 'lib/algolia/models/search/search_rules_params.rb', line 11

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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/algolia/models/search/search_rules_params.rb', line 168

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



40
41
42
 
# File 'lib/algolia/models/search/search_rules_params.rb', line 40

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
37
 
# File 'lib/algolia/models/search/search_rules_params.rb', line 28

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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/algolia/models/search/search_rules_params.rb', line 141

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



57
58
59
60
61
62
63
 
# File 'lib/algolia/models/search/search_rules_params.rb', line 57

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

.types_mapping ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/algolia/models/search/search_rules_params.rb', line 45

def self.types_mapping
  {
    :query => :"String",
    :anchoring => :"Anchoring",
    :context => :"String",
    :page => :"Integer",
    :hits_per_page => :"Integer",
    :enabled => :"Boolean"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



115
116
117
118
119
120
121
122
123
124
 
# File 'lib/algolia/models/search/search_rules_params.rb', line 115

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    query == other.query &&
    anchoring == other.anchoring &&
    context == other.context &&
    page == other.page &&
    hits_per_page == other.hits_per_page &&
    enabled == other.enabled
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



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/algolia/models/search/search_rules_params.rb', line 247

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


128
129
130
 
# File 'lib/algolia/models/search/search_rules_params.rb', line 128

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



134
135
136
 
# File 'lib/algolia/models/search/search_rules_params.rb', line 134

def hash
  [query, anchoring, context, page, hits_per_page, enabled].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



218
219
220
 
# File 'lib/algolia/models/search/search_rules_params.rb', line 218

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



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

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 



222
223
224
 
# File 'lib/algolia/models/search/search_rules_params.rb', line 222

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



212
213
214
 
# File 'lib/algolia/models/search/search_rules_params.rb', line 212

def to_s
  to_hash.to_s
end