class PureCloud::Operation

Attributes

action_name[RW]

Action name

action_status[RW]

Action status

complete[RW]
error_code[RW]
error_details[RW]
error_message[RW]
error_message_params[RW]
id[RW]
user[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/operation.rb, line 42
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'complete' => :'complete',
    
    :'user' => :'user',
    
    :'error_message' => :'errorMessage',
    
    :'error_code' => :'errorCode',
    
    :'error_details' => :'errorDetails',
    
    :'error_message_params' => :'errorMessageParams',
    
    :'action_name' => :'actionName',
    
    :'action_status' => :'actionStatus'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/operation.rb, line 82
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[:'complete']
    self.complete = attributes[:'complete']
  end
  
  if attributes[:'user']
    self.user = attributes[:'user']
  end
  
  if attributes[:'errorMessage']
    self.error_message = attributes[:'errorMessage']
  end
  
  if attributes[:'errorCode']
    self.error_code = attributes[:'errorCode']
  end
  
  if attributes[:'errorDetails']
    if (value = attributes[:'errorDetails']).is_a?(Array)
      self.error_details = value
    end
  end
  
  if attributes[:'errorMessageParams']
    if (value = attributes[:'errorMessageParams']).is_a?(Array)
      self.error_message_params = value
    end
  end
  
  if attributes[:'actionName']
    self.action_name = attributes[:'actionName']
  end
  
  if attributes[:'actionStatus']
    self.action_status = attributes[:'actionStatus']
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/operation.rb, line 67
def self.swagger_types
  {
    :'id' => :'String',
    :'complete' => :'BOOLEAN',
    :'user' => :'User',
    :'error_message' => :'String',
    :'error_code' => :'String',
    :'error_details' => :'Array<Detail>',
    :'error_message_params' => :'Hash<String, String>',
    :'action_name' => :'String',
    :'action_status' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/operation.rb, line 150
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      complete == o.complete &&
      user == o.user &&
      error_message == o.error_message &&
      error_code == o.error_code &&
      error_details == o.error_details &&
      error_message_params == o.error_message_params &&
      action_name == o.action_name &&
      action_status == o.action_status
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/operation.rb, line 194
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/operation.rb, line 254
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
action_name=(action_name) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/operation.rb, line 132
def action_name=(action_name)
  allowed_values = ["CHECKIN", "DEBUG", "DELETE", "PUBLISH", "STATE_CHANGE", "VALIDATE"]
  if action_name && !allowed_values.include?(action_name)
    fail "invalid value for 'action_name', must be one of #{allowed_values}"
  end
  @action_name = action_name
end
action_status=(action_status) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/operation.rb, line 141
def action_status=(action_status)
  allowed_values = ["LOCKED", "UNLOCKED", "STARTED", "PENDING_GENERATION", "PENDING_BACKEND_NOTIFICATION", "SUCCESS", "FAILURE"]
  if action_status && !allowed_values.include?(action_status)
    fail "invalid value for 'action_status', must be one of #{allowed_values}"
  end
  @action_status = action_status
end
build_from_hash(attributes) click to toggle source

build the object from hash

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

@see the `==` method

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

Calculate hash code according to all attributes.

# File lib/purecloud/models/operation.rb, line 170
def hash
  [id, complete, user, error_message, error_code, error_details, error_message_params, action_name, action_status].hash
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

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

return the object in the form of hash

# File lib/purecloud/models/operation.rb, line 242
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/operation.rb, line 232
def to_s
  to_hash.to_s
end