Class: Algolia::QuerySuggestions::BaseQuerySuggestionsConfigurationResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BaseQuerySuggestionsConfigurationResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash

[View source]

48
49
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
 
# File 'lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb', line 48

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

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

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

Instance Attribute Details

#external_indices_api_key ⇒ Object

API key used to read from external Algolia indices.


16
17
18
 
# File 'lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb', line 16

def external_indices_api_key
  @external_indices_api_key
end

#source_indices_api_key ⇒ Object

API key used to read from your source index.


10
11
12
 
# File 'lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb', line 10

def source_indices_api_key
  @source_indices_api_key
end

#suggestions_indices_api_key ⇒ Object

API key used to write and configure your Query Suggestions index.


13
14
15
 
# File 'lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb', line 13

def suggestions_indices_api_key
  @suggestions_indices_api_key
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]

136
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
 
# File 'lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb', line 136

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::QuerySuggestions.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

[View source]

28
29
30
 
# File 'lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb', line 28

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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

[View source]

19
20
21
22
23
24
25
 
# File 'lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb', line 19

def self.attribute_map
  {
    :source_indices_api_key => :sourceIndicesAPIKey,
    :suggestions_indices_api_key => :suggestionsIndicesAPIKey,
    :external_indices_api_key => :externalIndicesAPIKey
  }
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]

108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb', line 108

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

[View source]

42
43
44
 
# File 'lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb', line 42

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

.types_mapping ⇒ Object

Attribute type mapping.

[View source]

33
34
35
36
37
38
39
 
# File 'lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb', line 33

def self.types_mapping
  {
    :source_indices_api_key => :String,
    :suggestions_indices_api_key => :String,
    :external_indices_api_key => :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared

[View source]

84
85
86
87
88
89
90
91
 
# File 'lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb', line 84

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

  self.class == other.class &&
    source_indices_api_key == other.source_indices_api_key &&
    suggestions_indices_api_key == other.suggestions_indices_api_key &&
    external_indices_api_key == other.external_indices_api_key
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]

215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb', line 215

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]

95
96
97
 
# File 'lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb', line 95

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code

[View source]

101
102
103
 
# File 'lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb', line 101

def hash
  [source_indices_api_key, suggestions_indices_api_key, external_indices_api_key].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

[View source]

186
187
188
 
# File 'lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb', line 186

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

[View source]

196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb', line 196

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]

190
191
192
 
# File 'lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb', line 190

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

[View source]

180
181
182
 
# File 'lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb', line 180

def to_s
  to_hash.to_s
end