class Nodeum::TaskExecution

Attributes

bandwidth[RW]
destination_type[RW]
estimation_time[RW]
finalized_files[RW]
id[RW]
job_finished[RW]
job_started[RW]
log_time[RW]
name[RW]
processed_files[RW]
processed_size[RW]
source_type[RW]
status[RW]
task_id[RW]
to_process_files[RW]
to_process_size[RW]
workflow_action[RW]
workflow_type[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/nodeum_sdk/models/task_execution.rb, line 76
def self.attribute_map
  {
    :'id' => :'id',
    :'task_id' => :'task_id',
    :'name' => :'name',
    :'workflow_type' => :'workflow_type',
    :'workflow_action' => :'workflow_action',
    :'source_type' => :'source_type',
    :'destination_type' => :'destination_type',
    :'status' => :'status',
    :'log_time' => :'log_time',
    :'job_started' => :'job_started',
    :'job_finished' => :'job_finished',
    :'to_process_size' => :'to_process_size',
    :'processed_size' => :'processed_size',
    :'to_process_files' => :'to_process_files',
    :'processed_files' => :'processed_files',
    :'finalized_files' => :'finalized_files',
    :'estimation_time' => :'estimation_time',
    :'bandwidth' => :'bandwidth'
  }
end
build_from_hash(attributes) click to toggle source

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_execution.rb, line 330
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/nodeum_sdk/models/task_execution.rb, line 131
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Nodeum::TaskExecution` 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::TaskExecution`. 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?(:'task_id')
    self.task_id = attributes[:'task_id']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  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?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'log_time')
    self.log_time = attributes[:'log_time']
  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?(:'to_process_size')
    self.to_process_size = attributes[:'to_process_size']
  end

  if attributes.key?(:'processed_size')
    self.processed_size = attributes[:'processed_size']
  end

  if attributes.key?(:'to_process_files')
    self.to_process_files = attributes[:'to_process_files']
  end

  if attributes.key?(:'processed_files')
    self.processed_files = attributes[:'processed_files']
  end

  if attributes.key?(:'finalized_files')
    self.finalized_files = attributes[:'finalized_files']
  end

  if attributes.key?(:'estimation_time')
    self.estimation_time = attributes[:'estimation_time']
  end

  if attributes.key?(:'bandwidth')
    self.bandwidth = attributes[:'bandwidth']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/nodeum_sdk/models/task_execution.rb, line 124
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/nodeum_sdk/models/task_execution.rb, line 100
def self.openapi_types
  {
    :'id' => :'String',
    :'task_id' => :'Integer',
    :'name' => :'String',
    :'workflow_type' => :'String',
    :'workflow_action' => :'String',
    :'source_type' => :'String',
    :'destination_type' => :'String',
    :'status' => :'String',
    :'log_time' => :'String',
    :'job_started' => :'String',
    :'job_finished' => :'String',
    :'to_process_size' => :'Integer',
    :'processed_size' => :'Integer',
    :'to_process_files' => :'Integer',
    :'processed_files' => :'Integer',
    :'finalized_files' => :'Integer',
    :'estimation_time' => :'Integer',
    :'bandwidth' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/nodeum_sdk/models/task_execution.rb, line 292
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      task_id == o.task_id &&
      name == o.name &&
      workflow_type == o.workflow_type &&
      workflow_action == o.workflow_action &&
      source_type == o.source_type &&
      destination_type == o.destination_type &&
      status == o.status &&
      log_time == o.log_time &&
      job_started == o.job_started &&
      job_finished == o.job_finished &&
      to_process_size == o.to_process_size &&
      processed_size == o.processed_size &&
      to_process_files == o.to_process_files &&
      processed_files == o.processed_files &&
      finalized_files == o.finalized_files &&
      estimation_time == o.estimation_time &&
      bandwidth == o.bandwidth
end
_deserialize(type, value) click to toggle source

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_execution.rb, line 358
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
_to_hash(value) click to toggle source

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_execution.rb, line 427
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) click to toggle source

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_execution.rb, line 337
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
destination_type=(destination_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] destination_type Object to be assigned

# File lib/nodeum_sdk/models/task_execution.rb, line 272
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/nodeum_sdk/models/task_execution.rb, line 317
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/nodeum_sdk/models/task_execution.rb, line 323
def hash
  [id, task_id, name, workflow_type, workflow_action, source_type, destination_type, status, log_time, job_started, job_finished, to_process_size, processed_size, to_process_files, processed_files, finalized_files, estimation_time, bandwidth].hash
end
list_invalid_properties() click to toggle source

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_execution.rb, line 219
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
source_type=(source_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] source_type Object to be assigned

# File lib/nodeum_sdk/models/task_execution.rb, line 262
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
status=(status) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

# File lib/nodeum_sdk/models/task_execution.rb, line 282
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
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/nodeum_sdk/models/task_execution.rb, line 403
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/nodeum_sdk/models/task_execution.rb, line 409
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/nodeum_sdk/models/task_execution.rb, line 397
def to_s
  to_hash.to_s
end
valid?() click to toggle source

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_execution.rb, line 226
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)
  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
workflow_action=(workflow_action) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] workflow_action Object to be assigned

# File lib/nodeum_sdk/models/task_execution.rb, line 252
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
workflow_type=(workflow_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] workflow_type Object to be assigned

# File lib/nodeum_sdk/models/task_execution.rb, line 242
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