Class: IronWorker::NewTask

Inherits:
Object
  • Object
show all
Defined in:
lib/iron_ruby/models/new_task.rb,
lib/worker_ruby/models/new_task.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NewTask

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/iron_ruby/models/new_task.rb', line 79

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

end

Instance Attribute Details

#delay ⇒ Object

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



36
37
38
 
# File 'lib/iron_ruby/models/new_task.rb', line 36

def delay
  @delay
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_ruby/models/new_task.rb', line 30

def image
  @image
end

#max_retries ⇒ Object

"Number of automatic retries this task 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 task with the same image id and payload. The new task’s max_retries is one less than the original. The new task’s ‘retry_of` field is set to the original Task ID. The old task’s ‘retry_at` field is set to the new Task’s ID. Titan will delay the new task for retries_delay seconds before queueing it. Cancelled or successful tasks are never automatically retried."



45
46
47
 
# File 'lib/iron_ruby/models/new_task.rb', line 45

def max_retries
  @max_retries
end

#payload ⇒ Object

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



33
34
35
 
# File 'lib/iron_ruby/models/new_task.rb', line 33

def payload
  @payload
end

#priority ⇒ Object

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



42
43
44
 
# File 'lib/iron_ruby/models/new_task.rb', line 42

def priority
  @priority
end

#retries_delay ⇒ Object

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



48
49
50
 
# File 'lib/iron_ruby/models/new_task.rb', line 48

def retries_delay
  @retries_delay
end

#timeout ⇒ Object

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



39
40
41
 
# File 'lib/iron_ruby/models/new_task.rb', line 39

def timeout
  @timeout
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/iron_ruby/models/new_task.rb', line 52

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

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/iron_ruby/models/new_task.rb', line 65

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/iron_ruby/models/new_task.rb', line 140

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



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
 
# File 'lib/iron_ruby/models/new_task.rb', line 188

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 = IronWorker.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



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/iron_ruby/models/new_task.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

#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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/iron_ruby/models/new_task.rb', line 167

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


154
155
156
 
# File 'lib/iron_ruby/models/new_task.rb', line 154

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



160
161
162
 
# File 'lib/iron_ruby/models/new_task.rb', line 160

def hash
  [image, payload, delay, timeout, priority, max_retries, retries_delay].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



125
126
127
128
 
# File 'lib/iron_ruby/models/new_task.rb', line 125

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



234
235
236
 
# File 'lib/iron_ruby/models/new_task.rb', line 234

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



240
241
242
243
244
245
246
247
248
 
# File 'lib/iron_ruby/models/new_task.rb', line 240

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



228
229
230
 
# File 'lib/iron_ruby/models/new_task.rb', line 228

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



132
133
134
135
136
 
# File 'lib/iron_ruby/models/new_task.rb', line 132

def valid?
  return false if @image.nil?
  return false if @priority.nil?
  return true
end