Class: IronFunctions::Task

Inherits:
Object
  • Object
show all
Defined in:
lib/iron_functions/models/task.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Task

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/iron_functions/models/task.rb', line 120

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?(:'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 task completed, whether it was successul or failed. Always in UTC.



51
52
53
 
# File 'lib/iron_functions/models/task.rb', line 51

def completed_at
  @completed_at
end

#created_at ⇒ Object

Time when task was submitted. Always in UTC.



45
46
47
 
# File 'lib/iron_functions/models/task.rb', line 45

def created_at
  @created_at
end

#env_vars ⇒ Object

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



60
61
62
 
# File 'lib/iron_functions/models/task.rb', line 60

def env_vars
  @env_vars
end

#error ⇒ Object

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



39
40
41
 
# File 'lib/iron_functions/models/task.rb', line 39

def error
  @error
end

#group_name ⇒ Object

Group this task belongs to.



36
37
38
 
# File 'lib/iron_functions/models/task.rb', line 36

def group_name
  @group_name
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_functions/models/task.rb', line 30

def image
  @image
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_functions/models/task.rb', line 33

def payload
  @payload
end

#reason ⇒ Object

Machine usable reason for task 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.



42
43
44
 
# File 'lib/iron_functions/models/task.rb', line 42

def reason
  @reason
end

#retry_at ⇒ Object

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



57
58
59
 
# File 'lib/iron_functions/models/task.rb', line 57

def retry_at
  @retry_at
end

#retry_of ⇒ Object

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



54
55
56
 
# File 'lib/iron_functions/models/task.rb', line 54

def retry_of
  @retry_of
end

#started_at ⇒ Object

Time when task started execution. Always in UTC.



48
49
50
 
# File 'lib/iron_functions/models/task.rb', line 48

def started_at
  @started_at
end

Class Method Details

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/iron_functions/models/task.rb', line 85

def self.attribute_map
  {
    :'image' => :'image',
    :'payload' => :'payload',
    :'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.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/iron_functions/models/task.rb', line 102

def self.swagger_types
  {
    :'image' => :'String',
    :'payload' => :'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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/iron_functions/models/task.rb', line 202

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      image == o.image &&
      payload == o.payload &&
      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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/iron_functions/models/task.rb', line 254

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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/iron_functions/models/task.rb', line 320

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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/iron_functions/models/task.rb', line 233

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


220
221
222
 
# File 'lib/iron_functions/models/task.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



226
227
228
 
# File 'lib/iron_functions/models/task.rb', line 226

def hash
  [image, payload, 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



176
177
178
179
 
# File 'lib/iron_functions/models/task.rb', line 176

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



300
301
302
 
# File 'lib/iron_functions/models/task.rb', line 300

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



306
307
308
309
310
311
312
313
314
 
# File 'lib/iron_functions/models/task.rb', line 306

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



294
295
296
 
# File 'lib/iron_functions/models/task.rb', line 294

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



183
184
185
186
187
188
 
# File 'lib/iron_functions/models/task.rb', line 183

def valid?
  return false if @image.nil?
  reason_validator = EnumAttributeValidator.new('String', ["timeout", "killed", "bad_exit", "client_request"])
  return false unless reason_validator.valid?(@reason)
  return true
end