Class: Algolia::Search::Consequence

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

Overview

[Consequences](www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences) of a rule.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Consequence

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
97
98
 
# File 'lib/algolia/models/search/consequence.rb', line 60

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

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    unless self.class.attribute_map.key?(k.to_sym)
      raise ArgumentError,
            "`#{k}` is not a valid attribute in `Algolia::Consequence`. 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
  end

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

  if attributes.key?(:promote)
    if (value = attributes[:promote]).is_a?(Array)
      self.promote = value
    end
  end

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

  if attributes.key?(:hide)
    if (value = attributes[:hide]).is_a?(Array)
      self.hide = value
    end
  end

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

Instance Attribute Details

#filter_promotes ⇒ Object

Only use in combination with the ‘promote` consequence. When `true`, promoted results will be restricted to match the filters of the current search. When `false`, the promoted results will show up regardless of the filters.



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

def filter_promotes
  @filter_promotes
end

#hide ⇒ Object

Records to hide. By default, you can hide up to 50 records per rule.



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

def hide
  @hide
end

#params ⇒ Object

Returns the value of attribute params.



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

def params
  @params
end

#promote ⇒ Object

Records to promote.



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

def promote
  @promote
end

#user_data ⇒ Object

Custom JSON object that will be appended to the userData array in the response. This object isn’t interpreted by the API. It’s limited to 1kB of minified JSON.



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

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



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
 
# File 'lib/algolia/models/search/consequence.rb', line 153

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
  else # model
    # 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



36
37
38
 
# File 'lib/algolia/models/search/consequence.rb', line 36

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
33
 
# File 'lib/algolia/models/search/consequence.rb', line 25

def self.attribute_map
  {
    :params => :params,
    :promote => :promote,
    :filter_promotes => :filterPromotes,
    :hide => :hide,
    :user_data => :userData
  }
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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/algolia/models/search/consequence.rb', line 128

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



52
53
54
55
56
 
# File 'lib/algolia/models/search/consequence.rb', line 52

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

.types_mapping ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
 
# File 'lib/algolia/models/search/consequence.rb', line 41

def self.types_mapping
  {
    :params => :ConsequenceParams,
    :promote => :'Array<Promote>',
    :filter_promotes => :Boolean,
    :hide => :'Array<ConsequenceHide>',
    :user_data => :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/algolia/models/search/consequence.rb', line 102

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

  self.class == other.class &&
    params == other.params &&
    promote == other.promote &&
    filter_promotes == other.filter_promotes &&
    hide == other.hide &&
    user_data == other.user_data
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



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

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


115
116
117
 
# File 'lib/algolia/models/search/consequence.rb', line 115

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



121
122
123
 
# File 'lib/algolia/models/search/consequence.rb', line 121

def hash
  [params, promote, filter_promotes, hide, user_data].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



200
201
202
 
# File 'lib/algolia/models/search/consequence.rb', line 200

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



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

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 



204
205
206
 
# File 'lib/algolia/models/search/consequence.rb', line 204

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



194
195
196
 
# File 'lib/algolia/models/search/consequence.rb', line 194

def to_s
  to_hash.to_s
end