class PureCloud::CommandStatus

Attributes

command_type[RW]
document[RW]
expiration[RW]

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

id[RW]

The globally unique identifier for the object.

name[RW]
self_uri[RW]

The URI for this object

status_code[RW]
user_id[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/command_status.rb, line 41
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'expiration' => :'expiration',
    
    :'user_id' => :'userId',
    
    :'status_code' => :'statusCode',
    
    :'command_type' => :'commandType',
    
    :'document' => :'document',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/command_status.rb, line 78
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'expiration']
    self.expiration = attributes[:'expiration']
  end
  
  if attributes[:'userId']
    self.user_id = attributes[:'userId']
  end
  
  if attributes[:'statusCode']
    self.status_code = attributes[:'statusCode']
  end
  
  if attributes[:'commandType']
    self.command_type = attributes[:'commandType']
  end
  
  if attributes[:'document']
    self.document = attributes[:'document']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/command_status.rb, line 64
def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'expiration' => :'DateTime',
    :'user_id' => :'String',
    :'status_code' => :'String',
    :'command_type' => :'String',
    :'document' => :'Document',
    :'self_uri' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/command_status.rb, line 138
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      expiration == o.expiration &&
      user_id == o.user_id &&
      status_code == o.status_code &&
      command_type == o.command_type &&
      document == o.document &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/command_status.rb, line 181
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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

# File lib/purecloud/models/command_status.rb, line 241
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

build the object from hash

# File lib/purecloud/models/command_status.rb, line 162
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
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end
command_type=(command_type) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/command_status.rb, line 129
def command_type=(command_type)
  allowed_values = ["UPLOAD", "COPYDOCUMENT", "MOVEDOCUMENT", "DELETEWORKSPACE", "DELETEDOCUMENT", "DELETETAG", "UPDATETAG", "REINDEX", "CLEANUP", "REPLACEDOCUMENT"]
  if command_type && !allowed_values.include?(command_type)
    fail "invalid value for 'command_type', must be one of #{allowed_values}"
  end
  @command_type = command_type
end
eql?(o) click to toggle source

@see the `==` method

# File lib/purecloud/models/command_status.rb, line 152
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/command_status.rb, line 157
def hash
  [id, name, expiration, user_id, status_code, command_type, document, self_uri].hash
end
status_code=(status_code) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/command_status.rb, line 120
def status_code=(status_code)
  allowed_values = ["INPROGRESS", "COMPLETE", "ERROR", "CANCELING", "CANCELED"]
  if status_code && !allowed_values.include?(status_code)
    fail "invalid value for 'status_code', must be one of #{allowed_values}"
  end
  @status_code = status_code
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloud/models/command_status.rb, line 224
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloud/models/command_status.rb, line 229
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
to_s() click to toggle source
# File lib/purecloud/models/command_status.rb, line 219
def to_s
  to_hash.to_s
end