Class: Algolia::Ingestion::Source

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Source

Initializes the object



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
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/algolia/models/ingestion/source.rb', line 64

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

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

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

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

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

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

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

Instance Attribute Details

#authentication_id ⇒ Object

Universally unique identifier (UUID) of an authentication resource.



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

def authentication_id
  @authentication_id
end

#created_at ⇒ Object

Date of creation in RFC 3339 format.



24
25
26
 
# File 'lib/algolia/models/ingestion/source.rb', line 24

def created_at
  @created_at
end

#input ⇒ Object

Returns the value of attribute input.



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

def input
  @input
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#source_id ⇒ Object

Universally uniqud identifier (UUID) of a source.



12
13
14
 
# File 'lib/algolia/models/ingestion/source.rb', line 12

def source_id
  @source_id
end

#type ⇒ Object

Returns the value of attribute type.



14
15
16
 
# File 'lib/algolia/models/ingestion/source.rb', line 14

def type
  @type
end

#updated_at ⇒ Object

Date of last update in RFC 3339 format.



27
28
29
 
# File 'lib/algolia/models/ingestion/source.rb', line 27

def updated_at
  @updated_at
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/algolia/models/ingestion/source.rb', line 175

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

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/algolia/models/ingestion/source.rb', line 30

def self.attribute_map
  {
    :source_id => :sourceID,
    :type => :type,
    :name => :name,
    :input => :input,
    :authentication_id => :authenticationID,
    :created_at => :createdAt,
    :updated_at => :updatedAt
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/algolia/models/ingestion/source.rb', line 148

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



56
57
58
59
60
 
# File 'lib/algolia/models/ingestion/source.rb', line 56

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

.types_mapping ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/algolia/models/ingestion/source.rb', line 43

def self.types_mapping
  {
    :source_id => :"String",
    :type => :"SourceType",
    :name => :"String",
    :input => :"SourceInput",
    :authentication_id => :"String",
    :created_at => :"String",
    :updated_at => :"String"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/algolia/models/ingestion/source.rb', line 121

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    source_id == other.source_id &&
    type == other.type &&
    name == other.name &&
    input == other.input &&
    authentication_id == other.authentication_id &&
    created_at == other.created_at &&
    updated_at == other.updated_at
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/algolia/models/ingestion/source.rb', line 254

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

See Also:

  • `==` method


135
136
137
 
# File 'lib/algolia/models/ingestion/source.rb', line 135

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



141
142
143
 
# File 'lib/algolia/models/ingestion/source.rb', line 141

def hash
  [source_id, type, name, input, authentication_id, created_at, updated_at].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



225
226
227
 
# File 'lib/algolia/models/ingestion/source.rb', line 225

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/algolia/models/ingestion/source.rb', line 235

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 



229
230
231
 
# File 'lib/algolia/models/ingestion/source.rb', line 229

def to_json(*_args)
  to_hash.to_json
end

#to_s ⇒ String

Returns the string representation of the object



219
220
221
 
# File 'lib/algolia/models/ingestion/source.rb', line 219

def to_s
  to_hash.to_s
end