Class: Algolia::Ingestion::SourceCSV

Inherits:
Object
  • Object
show all
Defined in:
lib/algolia/models/ingestion/source_csv.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SourceCSV

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 81

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

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

  if attributes.key?(:mapping)
    if (value = attributes[:mapping]).is_a?(Hash)
      self.mapping = value
    end
  end

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

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

Instance Attribute Details

#delimiter ⇒ Object

The character used to split the value on each line, default to a comma (\r, \n, 0xFFFD, and space are forbidden).



21
22
23
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 21

def delimiter
  @delimiter
end

#mapping ⇒ Object

Key-value pairs of column names and their expected types.



16
17
18
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 16

def mapping
  @mapping
end

#method ⇒ Object

Returns the value of attribute method.



18
19
20
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 18

def method
  @method
end

#unique_id_column ⇒ Object

Name of a column that contains a unique ID which will be used as ‘objectID` in Algolia.



13
14
15
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 13

def unique_id_column
  @unique_id_column
end

#url ⇒ Object

URL of the file.



10
11
12
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 10

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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 202

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



57
58
59
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 57

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 46

def self.attribute_map
  {
    :url => :url,
    :unique_id_column => :uniqueIDColumn,
    :mapping => :mapping,
    :method => :method,
    :delimiter => :delimiter
  }
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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 175

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



73
74
75
76
77
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 73

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

.types_mapping ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 62

def self.types_mapping
  {
    :url => :"String",
    :unique_id_column => :"String",
    :mapping => :"Hash<String, MappingTypeCSV>",
    :method => :"MethodType",
    :delimiter => :"String"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



150
151
152
153
154
155
156
157
158
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 150

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    url == other.url &&
    unique_id_column == other.unique_id_column &&
    mapping == other.mapping &&
    method == other.method &&
    delimiter == other.delimiter
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



281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 281

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


162
163
164
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 162

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



168
169
170
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 168

def hash
  [url, unique_id_column, mapping, method, delimiter].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



252
253
254
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 252

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 262

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 



256
257
258
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 256

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



246
247
248
 
# File 'lib/algolia/models/ingestion/source_csv.rb', line 246

def to_s
  to_hash.to_s
end