Class: Algolia::QuerySuggestions::Configuration
- Inherits:
-
Object
- Object
- Algolia::QuerySuggestions::Configuration
- Defined in:
- lib/algolia/models/query-suggestions/configuration.rb
Overview
Query Suggestions configuration.
Instance Attribute Summary collapse
-
#allow_special_characters ⇒ Object
Whether to include suggestions with special characters.
-
#enable_personalization ⇒ Object
Whether to turn on personalized query suggestions.
-
#exclude ⇒ Object
Returns the value of attribute exclude.
-
#languages ⇒ Object
Returns the value of attribute languages.
-
#source_indices ⇒ Object
Algolia indices from which to get the popular searches for query suggestions.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.types_mapping ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Configuration
constructor
Initializes the object.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
- #to_json(*_args) ⇒ Object
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ Configuration
Initializes the object
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 99 100 101 102 103 104 105 106 107 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 61 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) raise( ArgumentError, "The input argument (attributes) must be a hash in `Algolia::Configuration` 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::Configuration`. 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?(:source_indices) if (value = attributes[:source_indices]).is_a?(Array) self.source_indices = value end else self.source_indices = nil end if attributes.key?(:languages) self.languages = attributes[:languages] end if attributes.key?(:exclude) if (value = attributes[:exclude]).is_a?(Array) self.exclude = value end end if attributes.key?(:enable_personalization) self.enable_personalization = attributes[:enable_personalization] end if attributes.key?(:allow_special_characters) self.allow_special_characters = attributes[:allow_special_characters] end end |
Instance Attribute Details
#allow_special_characters ⇒ Object
Whether to include suggestions with special characters.
21 22 23 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 21 def allow_special_characters @allow_special_characters end |
#enable_personalization ⇒ Object
Whether to turn on personalized query suggestions.
18 19 20 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 18 def enable_personalization @enable_personalization end |
#exclude ⇒ Object
Returns the value of attribute exclude.
15 16 17 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 15 def exclude @exclude end |
#languages ⇒ Object
Returns the value of attribute languages.
13 14 15 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 13 def languages @languages end |
#source_indices ⇒ Object
Algolia indices from which to get the popular searches for query suggestions.
11 12 13 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 11 def source_indices @source_indices end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 192 193 194 195 196 197 198 199 200 201 202 203 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 163 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
35 36 37 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 35 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
24 25 26 27 28 29 30 31 32 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 24 def self.attribute_map { :source_indices => :sourceIndices, :languages => :languages, :exclude => :exclude, :enable_personalization => :enablePersonalization, :allow_special_characters => :allowSpecialCharacters } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 136 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
51 52 53 54 55 56 57 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 51 def self.openapi_nullable Set.new( [ :exclude ] ) end |
.types_mapping ⇒ Object
Attribute type mapping.
40 41 42 43 44 45 46 47 48 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 40 def self.types_mapping { :source_indices => :"Array<SourceIndex>", :languages => :"Languages", :exclude => :"Array<String>", :enable_personalization => :"Boolean", :allow_special_characters => :"Boolean" } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
111 112 113 114 115 116 117 118 119 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 111 def ==(other) return true if self.equal?(other) self.class == other.class && source_indices == other.source_indices && languages == other.languages && exclude == other.exclude && enable_personalization == other.enable_personalization && allow_special_characters == other.allow_special_characters end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 242 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
123 124 125 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 123 def eql?(other) self == other end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
129 130 131 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 129 def hash [source_indices, languages, exclude, enable_personalization, allow_special_characters].hash end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
213 214 215 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 213 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
223 224 225 226 227 228 229 230 231 232 233 234 235 236 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 223 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
217 218 219 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 217 def to_json(*_args) to_hash.to_json end |
#to_s ⇒ String
Returns the string representation of the object
207 208 209 |
# File 'lib/algolia/models/query-suggestions/configuration.rb', line 207 def to_s to_hash.to_s end |