Class: IronTitan::NewJobWithImage

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NewJobWithImage

Returns a new instance of NewJobWithImage.



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
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/iron_titan/models/new_job_with_image.rb', line 79

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

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

  
  if attributes[:'payload']
    self.payload = attributes[:'payload']
  end
  
  if attributes[:'delay']
    self.delay = attributes[:'delay']
  else
    self.delay = 0
  end
  
  if attributes[:'timeout']
    self.timeout = attributes[:'timeout']
  else
    self.timeout = 60
  end
  
  if attributes[:'priority']
    self.priority = attributes[:'priority']
  else
    self.priority = 0
  end
  
  if attributes[:'max_retries']
    self.max_retries = attributes[:'max_retries']
  else
    self.max_retries = 3
  end
  
  if attributes[:'retries_delay']
    self.retries_delay = attributes[:'retries_delay']
  else
    self.retries_delay = 60
  end
  
  if attributes[:'image']
    self.image = attributes[:'image']
  end
  
  if attributes[:'created_at']
    self.created_at = attributes[:'created_at']
  end
  
end

Instance Attribute Details

#created_at ⇒ Object

Time when image first used/created.



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

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.



21
22
23
 
# File 'lib/iron_titan/models/new_job_with_image.rb', line 21

def delay
  @delay
end

#image ⇒ Object

Docker image to use for job.



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

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.nAutomatic 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.



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

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.



18
19
20
 
# File 'lib/iron_titan/models/new_job_with_image.rb', line 18

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.



27
28
29
 
# File 'lib/iron_titan/models/new_job_with_image.rb', line 27

def priority
  @priority
end

#retries_delay ⇒ Object

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



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

def retries_delay
  @retries_delay
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.



24
25
26
 
# File 'lib/iron_titan/models/new_job_with_image.rb', line 24

def timeout
  @timeout
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/iron_titan/models/new_job_with_image.rb', line 42

def self.attribute_map
  {
    
    :'payload' => :'payload',
    
    :'delay' => :'delay',
    
    :'timeout' => :'timeout',
    
    :'priority' => :'priority',
    
    :'max_retries' => :'max_retries',
    
    :'retries_delay' => :'retries_delay',
    
    :'image' => :'image',
    
    :'created_at' => :'created_at'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/iron_titan/models/new_job_with_image.rb', line 65

def self.swagger_types
  {
    :'payload' => :'String',
    :'delay' => :'Integer',
    :'timeout' => :'Integer',
    :'priority' => :'Integer',
    :'max_retries' => :'Integer',
    :'retries_delay' => :'Integer',
    :'image' => :'String',
    :'created_at' => :'DateTime'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/iron_titan/models/new_job_with_image.rb', line 131

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payload == o.payload &&
      delay == o.delay &&
      timeout == o.timeout &&
      priority == o.priority &&
      max_retries == o.max_retries &&
      retries_delay == o.retries_delay &&
      image == o.image &&
      created_at == o.created_at
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/iron_titan/models/new_job_with_image.rb', line 174

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
    _model = IronTitan.const_get(type).new
    _model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Object

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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/iron_titan/models/new_job_with_image.rb', line 234

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

build the object from hash



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/iron_titan/models/new_job_with_image.rb', line 155

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
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


145
146
147
 
# File 'lib/iron_titan/models/new_job_with_image.rb', line 145

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



150
151
152
 
# File 'lib/iron_titan/models/new_job_with_image.rb', line 150

def hash
  [payload, delay, timeout, priority, max_retries, retries_delay, image, created_at].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



217
218
219
 
# File 'lib/iron_titan/models/new_job_with_image.rb', line 217

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



222
223
224
225
226
227
228
229
230
 
# File 'lib/iron_titan/models/new_job_with_image.rb', line 222

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 ⇒ Object 



212
213
214
 
# File 'lib/iron_titan/models/new_job_with_image.rb', line 212

def to_s
  to_hash.to_s
end