Class: Algolia::Search::Edit
- Inherits:
-
Object
- Object
- Algolia::Search::Edit
- Defined in:
- lib/algolia/models/search/edit.rb
Instance Attribute Summary collapse
-
#delete ⇒ Object
Text or patterns to remove from the query string.
-
#insert ⇒ Object
Text to be added in place of the deleted text inside the query string.
-
#type ⇒ Object
Returns the value of attribute type.
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 = {}) ⇒ Edit
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 = {}) ⇒ Edit
Initializes the object
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 |
# File 'lib/algolia/models/search/edit.rb', line 49 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::Edit` 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::Edit`. 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?(:type) self.type = attributes[:type] end if attributes.key?(:delete) self.delete = attributes[:delete] end if attributes.key?(:insert) self.insert = attributes[:insert] end end |
Instance Attribute Details
#delete ⇒ Object
Text or patterns to remove from the query string.
12 13 14 |
# File 'lib/algolia/models/search/edit.rb', line 12 def delete @delete end |
#insert ⇒ Object
Text to be added in place of the deleted text inside the query string.
15 16 17 |
# File 'lib/algolia/models/search/edit.rb', line 15 def insert @insert end |
#type ⇒ Object
Returns the value of attribute type.
9 10 11 |
# File 'lib/algolia/models/search/edit.rb', line 9 def type @type end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
132 133 134 135 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 |
# File 'lib/algolia/models/search/edit.rb', line 132 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
27 28 29 |
# File 'lib/algolia/models/search/edit.rb', line 27 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
18 19 20 21 22 23 24 |
# File 'lib/algolia/models/search/edit.rb', line 18 def self.attribute_map { :type => :type, :delete => :delete, :insert => :insert } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/algolia/models/search/edit.rb', line 105 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
41 42 43 44 45 |
# File 'lib/algolia/models/search/edit.rb', line 41 def self.openapi_nullable Set.new( [] ) end |
.types_mapping ⇒ Object
Attribute type mapping.
32 33 34 35 36 37 38 |
# File 'lib/algolia/models/search/edit.rb', line 32 def self.types_mapping { :type => :"EditType", :delete => :"String", :insert => :"String" } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
82 83 84 85 86 87 88 |
# File 'lib/algolia/models/search/edit.rb', line 82 def ==(other) return true if self.equal?(other) self.class == other.class && type == other.type && delete == other.delete && insert == other.insert end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
211 212 213 214 215 216 217 218 219 220 221 222 223 |
# File 'lib/algolia/models/search/edit.rb', line 211 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
92 93 94 |
# File 'lib/algolia/models/search/edit.rb', line 92 def eql?(other) self == other end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
98 99 100 |
# File 'lib/algolia/models/search/edit.rb', line 98 def hash [type, delete, insert].hash end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
182 183 184 |
# File 'lib/algolia/models/search/edit.rb', line 182 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'lib/algolia/models/search/edit.rb', line 192 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
186 187 188 |
# File 'lib/algolia/models/search/edit.rb', line 186 def to_json(*_args) to_hash.to_json end |
#to_s ⇒ String
Returns the string representation of the object
176 177 178 |
# File 'lib/algolia/models/search/edit.rb', line 176 def to_s to_hash.to_s end |