class IronFunctions::Task
Attributes
Time when task completed, whether it was successul or failed. Always in UTC.
Time when task was submitted. Always in UTC.
Env vars for the task. Comes from the ones set on the Group.
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.
Group this task belongs to.
Name of Docker image to use. This is optional and can be used to override the image defined at the group level.
Payload for the task. This is what you pass into each task to make it do something.
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.
If this field is set, then this task was retried by the task referenced in this field.
If this field is set, then this task is a retry of the ID in this field.
Time when task started execution. Always in UTC.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# 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
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# 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
@see the `==` method @param [Object] Object to be compared
# File lib/iron_functions/models/task.rb, line 220 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/iron_functions/models/task.rb, line 176 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] reason Object to be assigned
# File lib/iron_functions/models/task.rb, line 192 def reason=(reason) validator = EnumAttributeValidator.new('String', ["timeout", "killed", "bad_exit", "client_request"]) unless validator.valid?(reason) fail ArgumentError, "invalid value for 'reason', must be one of #{validator.allowable_values}." end @reason = reason end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/iron_functions/models/task.rb, line 294 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# 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