class Nodeum::Task
Attributes
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/nodeum_sdk/models/task.rb, line 80 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'comment' => :'comment', :'workflow_type' => :'workflow_type', :'workflow_action' => :'workflow_action', :'source_type' => :'source_type', :'destination_type' => :'destination_type', :'priority' => :'priority', :'conflict_resolution' => :'conflict_resolution', :'action' => :'action', :'activate' => :'activate', :'creation_date' => :'creation_date', :'modification_date' => :'modification_date', :'creation_username' => :'creation_username', :'modification_username' => :'modification_username', :'status' => :'status', :'job_started' => :'job_started', :'job_finished' => :'job_finished', :'processed_size' => :'processed_size', :'to_process_size' => :'to_process_size' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/nodeum_sdk/models/task.rb, line 372 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/nodeum_sdk/models/task.rb, line 139 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Nodeum::Task` 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 `Nodeum::Task`. 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?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'comment') self.comment = attributes[:'comment'] end if attributes.key?(:'workflow_type') self.workflow_type = attributes[:'workflow_type'] end if attributes.key?(:'workflow_action') self.workflow_action = attributes[:'workflow_action'] end if attributes.key?(:'source_type') self.source_type = attributes[:'source_type'] end if attributes.key?(:'destination_type') self.destination_type = attributes[:'destination_type'] end if attributes.key?(:'priority') self.priority = attributes[:'priority'] end if attributes.key?(:'conflict_resolution') self.conflict_resolution = attributes[:'conflict_resolution'] end if attributes.key?(:'action') self.action = attributes[:'action'] end if attributes.key?(:'activate') self.activate = attributes[:'activate'] end if attributes.key?(:'creation_date') self.creation_date = attributes[:'creation_date'] end if attributes.key?(:'modification_date') self.modification_date = attributes[:'modification_date'] end if attributes.key?(:'creation_username') self.creation_username = attributes[:'creation_username'] end if attributes.key?(:'modification_username') self.modification_username = attributes[:'modification_username'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'job_started') self.job_started = attributes[:'job_started'] end if attributes.key?(:'job_finished') self.job_finished = attributes[:'job_finished'] end if attributes.key?(:'processed_size') self.processed_size = attributes[:'processed_size'] end if attributes.key?(:'to_process_size') self.to_process_size = attributes[:'to_process_size'] end end
List of attributes with nullable: true
# File lib/nodeum_sdk/models/task.rb, line 132 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/nodeum_sdk/models/task.rb, line 106 def self.openapi_types { :'id' => :'Integer', :'name' => :'String', :'comment' => :'String', :'workflow_type' => :'String', :'workflow_action' => :'String', :'source_type' => :'String', :'destination_type' => :'String', :'priority' => :'Integer', :'conflict_resolution' => :'String', :'action' => :'String', :'activate' => :'Boolean', :'creation_date' => :'String', :'modification_date' => :'String', :'creation_username' => :'String', :'modification_username' => :'String', :'status' => :'String', :'job_started' => :'String', :'job_finished' => :'String', :'processed_size' => :'Integer', :'to_process_size' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/nodeum_sdk/models/task.rb, line 332 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && comment == o.comment && workflow_type == o.workflow_type && workflow_action == o.workflow_action && source_type == o.source_type && destination_type == o.destination_type && priority == o.priority && conflict_resolution == o.conflict_resolution && action == o.action && activate == o.activate && creation_date == o.creation_date && modification_date == o.modification_date && creation_username == o.creation_username && modification_username == o.modification_username && status == o.status && job_started == o.job_started && job_finished == o.job_finished && processed_size == o.processed_size && to_process_size == o.to_process_size 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/nodeum_sdk/models/task.rb, line 400 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 Nodeum.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/nodeum_sdk/models/task.rb, line 469 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
Custom attribute writer method checking allowed values (enum). @param [Object] action Object to be assigned
# File lib/nodeum_sdk/models/task.rb, line 312 def action=(action) validator = EnumAttributeValidator.new('String', ["noop", "run", "pause", "stop", "resume"]) unless validator.valid?(action) fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}." end @action = action end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/nodeum_sdk/models/task.rb, line 379 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]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
Custom attribute writer method checking allowed values (enum). @param [Object] conflict_resolution
Object to be assigned
# File lib/nodeum_sdk/models/task.rb, line 302 def conflict_resolution=(conflict_resolution) validator = EnumAttributeValidator.new('String', ["rename", "overwrite", "ignore"]) unless validator.valid?(conflict_resolution) fail ArgumentError, "invalid value for \"conflict_resolution\", must be one of #{validator.allowable_values}." end @conflict_resolution = conflict_resolution end
Custom attribute writer method checking allowed values (enum). @param [Object] destination_type
Object to be assigned
# File lib/nodeum_sdk/models/task.rb, line 292 def destination_type=(destination_type) validator = EnumAttributeValidator.new('String', ["container", "primary_nas", "secondary_nas", "primary_cloud", "secondary_cloud", "secondary_tape"]) unless validator.valid?(destination_type) fail ArgumentError, "invalid value for \"destination_type\", must be one of #{validator.allowable_values}." end @destination_type = destination_type end
@see the `==` method @param [Object] Object to be compared
# File lib/nodeum_sdk/models/task.rb, line 359 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/nodeum_sdk/models/task.rb, line 365 def hash [id, name, comment, workflow_type, workflow_action, source_type, destination_type, priority, conflict_resolution, action, activate, creation_date, modification_date, creation_username, modification_username, status, job_started, job_finished, processed_size, to_process_size].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/nodeum_sdk/models/task.rb, line 235 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] source_type
Object to be assigned
# File lib/nodeum_sdk/models/task.rb, line 282 def source_type=(source_type) validator = EnumAttributeValidator.new('String', ["container", "primary_nas", "secondary_nas", "primary_cloud", "secondary_cloud", "secondary_tape"]) unless validator.valid?(source_type) fail ArgumentError, "invalid value for \"source_type\", must be one of #{validator.allowable_values}." end @source_type = source_type end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/nodeum_sdk/models/task.rb, line 322 def status=(status) validator = EnumAttributeValidator.new('String', ["not_activated", "done", "in_progress", "error", "paused", "stopped_by_system", "in_queue", "finished_with_warnings", "calculating", "stopped_by_user"]) 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/nodeum_sdk/models/task.rb, line 451 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/nodeum_sdk/models/task.rb, line 439 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/nodeum_sdk/models/task.rb, line 242 def valid? workflow_type_validator = EnumAttributeValidator.new('String', ["active_archive", "offline_archive", "data_exchange", "data_migration", "maintenance", "data_enrichment"]) return false unless workflow_type_validator.valid?(@workflow_type) workflow_action_validator = EnumAttributeValidator.new('String', ["copy", "move", "erase", "scan", "rehydratation", "format", "check_consistency", "duplication", "cache_cleaning", "ejection", "get_index", "full_backup", "incremental_backup"]) return false unless workflow_action_validator.valid?(@workflow_action) source_type_validator = EnumAttributeValidator.new('String', ["container", "primary_nas", "secondary_nas", "primary_cloud", "secondary_cloud", "secondary_tape"]) return false unless source_type_validator.valid?(@source_type) destination_type_validator = EnumAttributeValidator.new('String', ["container", "primary_nas", "secondary_nas", "primary_cloud", "secondary_cloud", "secondary_tape"]) return false unless destination_type_validator.valid?(@destination_type) conflict_resolution_validator = EnumAttributeValidator.new('String', ["rename", "overwrite", "ignore"]) return false unless conflict_resolution_validator.valid?(@conflict_resolution) action_validator = EnumAttributeValidator.new('String', ["noop", "run", "pause", "stop", "resume"]) return false unless action_validator.valid?(@action) status_validator = EnumAttributeValidator.new('String', ["not_activated", "done", "in_progress", "error", "paused", "stopped_by_system", "in_queue", "finished_with_warnings", "calculating", "stopped_by_user"]) return false unless status_validator.valid?(@status) true end
Custom attribute writer method checking allowed values (enum). @param [Object] workflow_action
Object to be assigned
# File lib/nodeum_sdk/models/task.rb, line 272 def workflow_action=(workflow_action) validator = EnumAttributeValidator.new('String', ["copy", "move", "erase", "scan", "rehydratation", "format", "check_consistency", "duplication", "cache_cleaning", "ejection", "get_index", "full_backup", "incremental_backup"]) unless validator.valid?(workflow_action) fail ArgumentError, "invalid value for \"workflow_action\", must be one of #{validator.allowable_values}." end @workflow_action = workflow_action end
Custom attribute writer method checking allowed values (enum). @param [Object] workflow_type
Object to be assigned
# File lib/nodeum_sdk/models/task.rb, line 262 def workflow_type=(workflow_type) validator = EnumAttributeValidator.new('String', ["active_archive", "offline_archive", "data_exchange", "data_migration", "maintenance", "data_enrichment"]) unless validator.valid?(workflow_type) fail ArgumentError, "invalid value for \"workflow_type\", must be one of #{validator.allowable_values}." end @workflow_type = workflow_type end