Class: Algolia::Ingestion::Run

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Run

Initializes the object

Parameters:

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

    Model attributes in the form of hash



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
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
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
 
# File 'lib/algolia/models/ingestion/run.rb', line 116

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#app_id ⇒ Object

Returns the value of attribute app_id.



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

def app_id
  @app_id
end

#created_at ⇒ Object

Date of creation in RFC 3339 format.



34
35
36
 
# File 'lib/algolia/models/ingestion/run.rb', line 34

def created_at
  @created_at
end

#failure_threshold ⇒ Object

Maximum accepted percentage of failures for a task run to finish successfully.



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

def failure_threshold
  @failure_threshold
end

#finished_at ⇒ Object

Date of finish in RFC 3339 format.



40
41
42
 
# File 'lib/algolia/models/ingestion/run.rb', line 40

def finished_at
  @finished_at
end

#outcome ⇒ Object

Returns the value of attribute outcome.



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

def outcome
  @outcome
end

#progress ⇒ Object

Returns the value of attribute progress.



19
20
21
 
# File 'lib/algolia/models/ingestion/run.rb', line 19

def progress
  @progress
end

#reason ⇒ Object

More information about the task run’s outcome.



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

def reason
  @reason
end

#reason_code ⇒ Object

Returns the value of attribute reason_code.



29
30
31
 
# File 'lib/algolia/models/ingestion/run.rb', line 29

def reason_code
  @reason_code
end

#run_id ⇒ Object

Universally unique identifier (UUID) of a task run.



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

def run_id
  @run_id
end

#started_at ⇒ Object

Date of start in RFC 3339 format.



37
38
39
 
# File 'lib/algolia/models/ingestion/run.rb', line 37

def started_at
  @started_at
end

#status ⇒ Object

Returns the value of attribute status.



17
18
19
 
# File 'lib/algolia/models/ingestion/run.rb', line 17

def status
  @status
end

#task_id ⇒ Object

Universally unique identifier (UUID) of a task.



15
16
17
 
# File 'lib/algolia/models/ingestion/run.rb', line 15

def task_id
  @task_id
end

#type ⇒ Object

Returns the value of attribute type.



31
32
33
 
# File 'lib/algolia/models/ingestion/run.rb', line 31

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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/algolia/models/ingestion/run.rb', line 293

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



84
85
86
 
# File 'lib/algolia/models/ingestion/run.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/algolia/models/ingestion/run.rb', line 65

def self.attribute_map
  {
    :run_id => :runID,
    :app_id => :appID,
    :task_id => :taskID,
    :status => :status,
    :progress => :progress,
    :outcome => :outcome,
    :failure_threshold => :failureThreshold,
    :reason => :reason,
    :reason_code => :reasonCode,
    :type => :type,
    :created_at => :createdAt,
    :started_at => :startedAt,
    :finished_at => :finishedAt
  }
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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/algolia/models/ingestion/run.rb', line 266

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



108
109
110
111
112
 
# File 'lib/algolia/models/ingestion/run.rb', line 108

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

.types_mapping ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/algolia/models/ingestion/run.rb', line 89

def self.types_mapping
  {
    :run_id => :"String",
    :app_id => :"String",
    :task_id => :"String",
    :status => :"RunStatus",
    :progress => :"RunProgress",
    :outcome => :"RunOutcome",
    :failure_threshold => :"Integer",
    :reason => :"String",
    :reason_code => :"RunReasonCode",
    :type => :"RunType",
    :created_at => :"String",
    :started_at => :"String",
    :finished_at => :"String"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/algolia/models/ingestion/run.rb', line 219

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    run_id == other.run_id &&
    app_id == other.app_id &&
    task_id == other.task_id &&
    status == other.status &&
    progress == other.progress &&
    outcome == other.outcome &&
    failure_threshold == other.failure_threshold &&
    reason == other.reason &&
    reason_code == other.reason_code &&
    type == other.type &&
    created_at == other.created_at &&
    started_at == other.started_at &&
    finished_at == other.finished_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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/algolia/models/ingestion/run.rb', line 372

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


239
240
241
 
# File 'lib/algolia/models/ingestion/run.rb', line 239

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/algolia/models/ingestion/run.rb', line 245

def hash
  [
    run_id,
    app_id,
    task_id,
    status,
    progress,
    outcome,
    failure_threshold,
    reason,
    reason_code,
    type,
    created_at,
    started_at,
    finished_at
  ].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



343
344
345
 
# File 'lib/algolia/models/ingestion/run.rb', line 343

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



353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/algolia/models/ingestion/run.rb', line 353

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 



347
348
349
 
# File 'lib/algolia/models/ingestion/run.rb', line 347

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



337
338
339
 
# File 'lib/algolia/models/ingestion/run.rb', line 337

def to_s
  to_hash.to_s
end