class EmassClient::InstancesTransitions
Attributes
- Read-Only
-
Comments entered by the user when performing the transition.
- Read-Only
-
User that performed the workflow transition.
- Read-Only
-
Date the workflow instance or the workflow transition was created.
- Read-Only
-
Description of the stage transition. This matches the action dropdown that appears for PAC users.
- Read-Only
-
The landing stage that is active after performing a transition.
- Read-Only
-
The beginning stage that is active before performing a transition.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/emass_client/models/instances_transitions.rb, line 57 def self.attribute_map { :'comments' => :'comments', :'created_by' => :'createdBy', :'created_date' => :'createdDate', :'description' => :'description', :'end_stage' => :'endStage', :'start_stage' => :'startStage' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/emass_client/models/instances_transitions.rb, line 215 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/emass_client/models/instances_transitions.rb, line 88 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `EmassClient::InstancesTransitions` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `EmassClient::InstancesTransitions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'comments') self.comments = attributes[:'comments'] end if attributes.key?(:'created_by') self.created_by = attributes[:'created_by'] end if attributes.key?(:'created_date') self.created_date = attributes[:'created_date'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'end_stage') self.end_stage = attributes[:'end_stage'] end if attributes.key?(:'start_stage') self.start_stage = attributes[:'start_stage'] end end
List of attributes with nullable: true
# File lib/emass_client/models/instances_transitions.rb, line 81 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/emass_client/models/instances_transitions.rb, line 69 def self.openapi_types { :'comments' => :'Object', :'created_by' => :'Object', :'created_date' => :'Object', :'description' => :'Object', :'end_stage' => :'Object', :'start_stage' => :'Object' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/emass_client/models/instances_transitions.rb, line 189 def ==(o) return true if self.equal?(o) self.class == o.class && comments == o.comments && created_by == o.created_by && created_date == o.created_date && description == o.description && end_stage == o.end_stage && start_stage == o.start_stage 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/emass_client/models/instances_transitions.rb, line 245 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 =~ /\A(true|t|yes|y|1)\z/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 EmassClient.const_get(type).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/emass_client/models/instances_transitions.rb, line 314 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/emass_client/models/instances_transitions.rb, line 222 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that 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]])) elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) end end self end
Custom attribute writer method checking allowed values (enum). @param [Object] comments Object to be assigned
# File lib/emass_client/models/instances_transitions.rb, line 149 def comments=(comments) validator = EnumAttributeValidator.new('Object', ['Approved the categorization', 'Submitted the categorization', 'Categorized the system as HMM', 'Selected POA&M Items']) unless validator.valid?(comments) fail ArgumentError, "invalid value for \"comments\", must be one of #{validator.allowable_values}." end @comments = comments end
Custom attribute writer method checking allowed values (enum). @param [Object] description Object to be assigned
# File lib/emass_client/models/instances_transitions.rb, line 159 def description=(description) validator = EnumAttributeValidator.new('Object', ['Initiate Workflow', 'Approve', 'Submit New Package', 'Disapprove and Move Forward', 'Cancel', 'Deny']) unless validator.valid?(description) fail ArgumentError, "invalid value for \"description\", must be one of #{validator.allowable_values}." end @description = description end
Custom attribute writer method checking allowed values (enum). @param [Object] end_stage
Object to be assigned
# File lib/emass_client/models/instances_transitions.rb, line 169 def end_stage=(end_stage) validator = EnumAttributeValidator.new('Object', ['PM/ISO', 'Echelon I', 'Echelon II', 'Echelon III', 'Categorize System', 'Submit Categorization', 'Approval', 'Complete']) unless validator.valid?(end_stage) fail ArgumentError, "invalid value for \"end_stage\", must be one of #{validator.allowable_values}." end @end_stage = end_stage end
@see the ‘==` method @param [Object] Object to be compared
# File lib/emass_client/models/instances_transitions.rb, line 202 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/emass_client/models/instances_transitions.rb, line 208 def hash [comments, created_by, created_date, description, end_stage, start_stage].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/emass_client/models/instances_transitions.rb, line 128 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] start_stage
Object to be assigned
# File lib/emass_client/models/instances_transitions.rb, line 179 def start_stage=(start_stage) validator = EnumAttributeValidator.new('Object', ['Not Started', 'PM/ISO', 'Categorize System', 'Submit Categorization', 'Approval', 'Deny']) unless validator.valid?(start_stage) fail ArgumentError, "invalid value for \"start_stage\", must be one of #{validator.allowable_values}." end @start_stage = start_stage end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/emass_client/models/instances_transitions.rb, line 296 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/emass_client/models/instances_transitions.rb, line 284 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/emass_client/models/instances_transitions.rb, line 135 def valid? comments_validator = EnumAttributeValidator.new('Object', ['Approved the categorization', 'Submitted the categorization', 'Categorized the system as HMM', 'Selected POA&M Items']) return false unless comments_validator.valid?(@comments) description_validator = EnumAttributeValidator.new('Object', ['Initiate Workflow', 'Approve', 'Submit New Package', 'Disapprove and Move Forward', 'Cancel', 'Deny']) return false unless description_validator.valid?(@description) end_stage_validator = EnumAttributeValidator.new('Object', ['PM/ISO', 'Echelon I', 'Echelon II', 'Echelon III', 'Categorize System', 'Submit Categorization', 'Approval', 'Complete']) return false unless end_stage_validator.valid?(@end_stage) start_stage_validator = EnumAttributeValidator.new('Object', ['Not Started', 'PM/ISO', 'Categorize System', 'Submit Categorization', 'Approval', 'Deny']) return false unless start_stage_validator.valid?(@start_stage) true end