class IronTitan::IdStatus
Attributes
Unique identifier representing a specific job.
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.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/iron_titan/models/id_status.rb, line 58 def self.attribute_map { :'id' => :'id', :'status' => :'status' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/iron_titan/models/id_status.rb, line 75 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?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end end
Attribute type mapping.
# File lib/iron_titan/models/id_status.rb, line 66 def self.swagger_types { :'id' => :'String', :'status' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/iron_titan/models/id_status.rb, line 118 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && status == o.status 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_titan/models/id_status.rb, line 161 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
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_titan/models/id_status.rb, line 227 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_titan/models/id_status.rb, line 140 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_titan/models/id_status.rb, line 127 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/iron_titan/models/id_status.rb, line 133 def hash [id, status].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/iron_titan/models/id_status.rb, line 93 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/iron_titan/models/id_status.rb, line 108 def status=(status) validator = EnumAttributeValidator.new('String', ["delayed", "queued", "running", "success", "error", "cancelled"]) unless validator.valid?(status) fail ArgumentError, "invalid value for 'status', must be one of #{validator.allowable_values}." end @status = status end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/iron_titan/models/id_status.rb, line 213 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_titan/models/id_status.rb, line 201 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_titan/models/id_status.rb, line 100 def valid? status_validator = EnumAttributeValidator.new('String', ["delayed", "queued", "running", "success", "error", "cancelled"]) return false unless status_validator.valid?(@status) return true end