Class: IronTitan::Job

Inherits:
Object
  • Object
show all
Defined in:
lib/iron_titan/models/job.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Job

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
198
199
200
201
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
243
 
# File 'lib/iron_titan/models/job.rb', line 155

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'image')
    self.image = attributes[:'image']
  end

  if attributes.has_key?(:'payload')
    self.payload = attributes[:'payload']
  end

  if attributes.has_key?(:'delay')
    self.delay = attributes[:'delay']
  else
    self.delay = 0
  end

  if attributes.has_key?(:'timeout')
    self.timeout = attributes[:'timeout']
  else
    self.timeout = 60
  end

  if attributes.has_key?(:'priority')
    self.priority = attributes[:'priority']
  end

  if attributes.has_key?(:'max_retries')
    self.max_retries = attributes[:'max_retries']
  else
    self.max_retries = 0
  end

  if attributes.has_key?(:'retries_delay')
    self.retries_delay = attributes[:'retries_delay']
  else
    self.retries_delay = 60
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'group_name')
    self.group_name = attributes[:'group_name']
  end

  if attributes.has_key?(:'error')
    self.error = attributes[:'error']
  end

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

  if attributes.has_key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

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

  if attributes.has_key?(:'completed_at')
    self.completed_at = attributes[:'completed_at']
  end

  if attributes.has_key?(:'retry_of')
    self.retry_of = attributes[:'retry_of']
  end

  if attributes.has_key?(:'retry_at')
    self.retry_at = attributes[:'retry_at']
  end

  if attributes.has_key?(:'env_vars')
    if (value = attributes[:'env_vars']).is_a?(Array)
      self.env_vars = value
    end
  end

end

Instance Attribute Details

#completed_at ⇒ Object

Time when job completed, whether it was successul or failed. Always in UTC.



72
73
74
 
# File 'lib/iron_titan/models/job.rb', line 72

def completed_at
  @completed_at
end

#created_at ⇒ Object

Time when job was submitted. Always in UTC.



66
67
68
 
# File 'lib/iron_titan/models/job.rb', line 66

def created_at
  @created_at
end

#delay ⇒ Object

Number of seconds to wait before queueing the job for consumption for the first time. Must be a positive integer. Jobs with a delay start in state "delayed" and transition to "running" after delay seconds.



36
37
38
 
# File 'lib/iron_titan/models/job.rb', line 36

def delay
  @delay
end

#env_vars ⇒ Object

Env vars for the task. Comes from the ones set on the Group.



81
82
83
 
# File 'lib/iron_titan/models/job.rb', line 81

def env_vars
  @env_vars
end

#error ⇒ Object

The error message, if status is ‘error’. This is errors due to things outside the job itself. Errors from user code will be found in the log.



60
61
62
 
# File 'lib/iron_titan/models/job.rb', line 60

def error
  @error
end

#group_name ⇒ Object

Group this job belongs to.



57
58
59
 
# File 'lib/iron_titan/models/job.rb', line 57

def group_name
  @group_name
end

#id ⇒ Object

Unique identifier representing a specific job.



51
52
53
 
# File 'lib/iron_titan/models/job.rb', line 51

def id
  @id
end

#image ⇒ Object

Name of Docker image to use. This is optional and can be used to override the image defined at the group level.



30
31
32
 
# File 'lib/iron_titan/models/job.rb', line 30

def image
  @image
end

#max_retries ⇒ Object

"Number of automatic retries this job is allowed. A retry will be attempted if a task fails. Max 25. Automatic retries are performed by titan when a task reaches a failed state and has ‘max_retries` > 0. A retry is performed by queueing a new job with the same image id and payload. The new job’s max_retries is one less than the original. The new job’s ‘retry_of` field is set to the original Job ID. Titan will delay the new job for retries_delay seconds before queueing it. Cancelled or successful tasks are never automatically retried."



45
46
47
 
# File 'lib/iron_titan/models/job.rb', line 45

def max_retries
  @max_retries
end

#payload ⇒ Object

Payload for the job. This is what you pass into each job to make it do something.



33
34
35
 
# File 'lib/iron_titan/models/job.rb', line 33

def payload
  @payload
end

#priority ⇒ Object

Priority of the job. Higher has more priority. 3 levels from 0-2. Jobs at same priority are processed in FIFO order.



42
43
44
 
# File 'lib/iron_titan/models/job.rb', line 42

def priority
  @priority
end

#reason ⇒ Object

Machine usable reason for job being in this state. Valid values for error status are ‘timeout | killed | bad_exit`. Valid values for cancelled status are `client_request`. For everything else, this is undefined.



63
64
65
 
# File 'lib/iron_titan/models/job.rb', line 63

def reason
  @reason
end

#retries_delay ⇒ Object

Time in seconds to wait before retrying the job. Must be a non-negative integer.



48
49
50
 
# File 'lib/iron_titan/models/job.rb', line 48

def retries_delay
  @retries_delay
end

#retry_at ⇒ Object

If this field is set, then this job was retried by the job referenced in this field.



78
79
80
 
# File 'lib/iron_titan/models/job.rb', line 78

def retry_at
  @retry_at
end

#retry_of ⇒ Object

If this field is set, then this job is a retry of the ID in this field.



75
76
77
 
# File 'lib/iron_titan/models/job.rb', line 75

def retry_of
  @retry_of
end

#started_at ⇒ Object

Time when job started execution. Always in UTC.



69
70
71
 
# File 'lib/iron_titan/models/job.rb', line 69

def started_at
  @started_at
end

#status ⇒ Object

States and valid transitions. --------- ———> delayed <—————- ----—-+ | | | | | ----v---- | ———> queued <—————- ----—-+ * | * | retry * creates new job ----v---- * | running | * ----–+ | ———|-|-|—–------------- —|———+ | —–|——— | | | | | | | —–v—^- --v-------^ –v—^- | success | | cancelled | | error | ----------- ----------- -------- * delayed - has a delay. * queued - Ready to be consumed when it’s turn comes. * running - Currently consumed by a runner which will attempt to process it. * success - (or complete? success/error is common javascript terminology) * error - Something went wrong. In this case more information can be obtained by inspecting the "reason" field. - timeout - killed - forcibly killed by worker due to resource restrictions or access violations. - bad_exit - exited with non-zero status due to program termination/crash. * cancelled - cancelled via API. More information in the reason field. - client_request - Request was cancelled by a client.



54
55
56
 
# File 'lib/iron_titan/models/job.rb', line 54

def status
  @status
end

#timeout ⇒ Object

Maximum runtime in seconds. If a consumer retrieves the job, but does not change it’s status within timeout seconds, the job is considered failed, with reason timeout (Titan may allow a small grace period). The consumer should also kill the job after timeout seconds. If a consumer tries to change status after Titan has already timed out the job, the consumer will be ignored.



39
40
41
 
# File 'lib/iron_titan/models/job.rb', line 39

def timeout
  @timeout
end

Class Method Details

.attribute_map ⇒ Object

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/iron_titan/models/job.rb', line 106

def self.attribute_map
  {
    :'image' => :'image',
    :'payload' => :'payload',
    :'delay' => :'delay',
    :'timeout' => :'timeout',
    :'priority' => :'priority',
    :'max_retries' => :'max_retries',
    :'retries_delay' => :'retries_delay',
    :'id' => :'id',
    :'status' => :'status',
    :'group_name' => :'group_name',
    :'error' => :'error',
    :'reason' => :'reason',
    :'created_at' => :'created_at',
    :'started_at' => :'started_at',
    :'completed_at' => :'completed_at',
    :'retry_of' => :'retry_of',
    :'retry_at' => :'retry_at',
    :'env_vars' => :'env_vars'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/iron_titan/models/job.rb', line 130

def self.swagger_types
  {
    :'image' => :'String',
    :'payload' => :'String',
    :'delay' => :'Integer',
    :'timeout' => :'Integer',
    :'priority' => :'Integer',
    :'max_retries' => :'Integer',
    :'retries_delay' => :'Integer',
    :'id' => :'String',
    :'status' => :'String',
    :'group_name' => :'String',
    :'error' => :'String',
    :'reason' => :'String',
    :'created_at' => :'DateTime',
    :'started_at' => :'DateTime',
    :'completed_at' => :'DateTime',
    :'retry_of' => :'String',
    :'retry_at' => :'String',
    :'env_vars' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/iron_titan/models/job.rb', line 286

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      image == o.image &&
      payload == o.payload &&
      delay == o.delay &&
      timeout == o.timeout &&
      priority == o.priority &&
      max_retries == o.max_retries &&
      retries_delay == o.retries_delay &&
      id == o.id &&
      status == o.status &&
      group_name == o.group_name &&
      error == o.error &&
      reason == o.reason &&
      created_at == o.created_at &&
      started_at == o.started_at &&
      completed_at == o.completed_at &&
      retry_of == o.retry_of &&
      retry_at == o.retry_at &&
      env_vars == o.env_vars
end

#_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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/iron_titan/models/job.rb', line 345

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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 =~ /^(true|t|yes|y|1)$/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
  else # model
    temp_model = IronTitan.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/iron_titan/models/job.rb', line 411

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

#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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/iron_titan/models/job.rb', line 324

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


311
312
313
 
# File 'lib/iron_titan/models/job.rb', line 311

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



317
318
319
 
# File 'lib/iron_titan/models/job.rb', line 317

def hash
  [image, payload, delay, timeout, priority, max_retries, retries_delay, id, status, group_name, error, reason, created_at, started_at, completed_at, retry_of, retry_at, env_vars].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



247
248
249
250
 
# File 'lib/iron_titan/models/job.rb', line 247

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



391
392
393
 
# File 'lib/iron_titan/models/job.rb', line 391

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



397
398
399
400
401
402
403
404
405
 
# File 'lib/iron_titan/models/job.rb', line 397

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



385
386
387
 
# File 'lib/iron_titan/models/job.rb', line 385

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



254
255
256
257
258
259
260
261
262
 
# File 'lib/iron_titan/models/job.rb', line 254

def valid?
  return false if @image.nil?
  return false if @priority.nil?
  status_validator = EnumAttributeValidator.new('String', ["delayed", "queued", "running", "success", "error", "cancelled"])
  return false unless status_validator.valid?(@status)
  reason_validator = EnumAttributeValidator.new('String', ["timeout", "killed", "bad_exit", "client_request"])
  return false unless reason_validator.valid?(@reason)
  return true
end