Class: Algolia::Search::PromoteObjectIDs

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

Overview

Records to promote.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PromoteObjectIDs

Initializes the object

Parameters:

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

    Model attributes in the form of hash

[View source]

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

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

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

Instance Attribute Details

#object_idsObject

Object IDs of the records you want to promote. The records are placed as a group at the ‘position`. For example, if you want to promote four records to position `0`, they will be the first four search results.


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

def object_ids
  @object_ids
end

#positionObject

Position in the search results where you want to show the promoted records.


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

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

[View source]

137
138
139
140
141
142
143
144
145
146
147
148
149
150
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
# File 'lib/algolia/models/search/promote_object_ids.rb', line 137

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_mapObject

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

[View source]

19
20
21
22
23
24
# File 'lib/algolia/models/search/promote_object_ids.rb', line 19

def self.attribute_map
  {
    :object_ids => :objectIDs,
    :position => :position
  }
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

[View source]

110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/algolia/models/search/promote_object_ids.rb', line 110

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

.discriminator_attributesObject

Returns the keys that uniquely identify this oneOf variant when present

[View source]

27
28
29
30
31
# File 'lib/algolia/models/search/promote_object_ids.rb', line 27

def self.discriminator_attributes
  [
    :objectIDs
  ]
end

.openapi_nullableObject

List of attributes with nullable: true

[View source]

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

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

.types_mappingObject

Attribute type mapping.

[View source]

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

def self.types_mapping
  {
    :object_ids => :"Array<String>",
    :position => :"Integer"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared

[View source]

88
89
90
91
92
93
# File 'lib/algolia/models/search/promote_object_ids.rb', line 88

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    object_ids == other.object_ids &&
    position == other.position
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

[View source]

216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/algolia/models/search/promote_object_ids.rb', line 216

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
[View source]

97
98
99
# File 'lib/algolia/models/search/promote_object_ids.rb', line 97

def eql?(other)
  self == other
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code

[View source]

103
104
105
# File 'lib/algolia/models/search/promote_object_ids.rb', line 103

def hash
  [object_ids, position].hash
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash

[View source]

187
188
189
# File 'lib/algolia/models/search/promote_object_ids.rb', line 187

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash

[View source]

197
198
199
200
201
202
203
204
205
206
207
208
209
210
# File 'lib/algolia/models/search/promote_object_ids.rb', line 197

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

[View source]

191
192
193
# File 'lib/algolia/models/search/promote_object_ids.rb', line 191

def to_json(*_args)
  to_hash.to_json
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object

[View source]

181
182
183
# File 'lib/algolia/models/search/promote_object_ids.rb', line 181

def to_s
  to_hash.to_s
end