class PureCloud::RecordingJob

Attributes

date_created[RW]

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

error_message[RW]

Error occurred during the job execution

id[RW]

The globally unique identifier for the object.

percent_progress[RW]

Progress in percentage based on the number of recordings

recording_jobs_query[RW]

Original query of the job.

self_uri[RW]

The URI for this object

state[RW]

The current state of the job.

total_conversations[RW]

Total number of conversations affected.

total_processed_recordings[RW]

Total number of recordings have been processed.

total_recordings[RW]

Total number of recordings affected.

user[RW]

Details of the user created the job

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/recording_job.rb, line 55
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'state' => :'state',
    
    :'recording_jobs_query' => :'recordingJobsQuery',
    
    :'date_created' => :'dateCreated',
    
    :'total_conversations' => :'totalConversations',
    
    :'total_recordings' => :'totalRecordings',
    
    :'total_processed_recordings' => :'totalProcessedRecordings',
    
    :'percent_progress' => :'percentProgress',
    
    :'error_message' => :'errorMessage',
    
    :'self_uri' => :'selfUri',
    
    :'user' => :'user'
    
  }
end
new(attributes = {}) click to toggle source

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

# File lib/purecloudplatformclientv2/models/recording_job.rb, line 114
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

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

  
  if attributes.has_key?(:'id')
    
    
    self.id = attributes[:'id']
    
  
  end

  
  if attributes.has_key?(:'state')
    
    
    self.state = attributes[:'state']
    
  
  end

  
  if attributes.has_key?(:'recordingJobsQuery')
    
    
    self.recording_jobs_query = attributes[:'recordingJobsQuery']
    
  
  end

  
  if attributes.has_key?(:'dateCreated')
    
    
    self.date_created = attributes[:'dateCreated']
    
  
  end

  
  if attributes.has_key?(:'totalConversations')
    
    
    self.total_conversations = attributes[:'totalConversations']
    
  
  end

  
  if attributes.has_key?(:'totalRecordings')
    
    
    self.total_recordings = attributes[:'totalRecordings']
    
  
  end

  
  if attributes.has_key?(:'totalProcessedRecordings')
    
    
    self.total_processed_recordings = attributes[:'totalProcessedRecordings']
    
  
  end

  
  if attributes.has_key?(:'percentProgress')
    
    
    self.percent_progress = attributes[:'percentProgress']
    
  
  end

  
  if attributes.has_key?(:'errorMessage')
    
    
    self.error_message = attributes[:'errorMessage']
    
  
  end

  
  if attributes.has_key?(:'selfUri')
    
    
    self.self_uri = attributes[:'selfUri']
    
  
  end

  
  if attributes.has_key?(:'user')
    
    
    self.user = attributes[:'user']
    
  
  end

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/recording_job.rb, line 84
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'state' => :'String',
    
    :'recording_jobs_query' => :'RecordingJobsQuery',
    
    :'date_created' => :'DateTime',
    
    :'total_conversations' => :'Integer',
    
    :'total_recordings' => :'Integer',
    
    :'total_processed_recordings' => :'Integer',
    
    :'percent_progress' => :'Integer',
    
    :'error_message' => :'String',
    
    :'self_uri' => :'String',
    
    :'user' => :'AddressableEntityRef'
    
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/purecloudplatformclientv2/models/recording_job.rb, line 358
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      state == o.state &&
      recording_jobs_query == o.recording_jobs_query &&
      date_created == o.date_created &&
      total_conversations == o.total_conversations &&
      total_recordings == o.total_recordings &&
      total_processed_recordings == o.total_processed_recordings &&
      percent_progress == o.percent_progress &&
      error_message == o.error_message &&
      self_uri == o.self_uri &&
      user == o.user
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/recording_job.rb, line 406
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/purecloudplatformclientv2/models/recording_job.rb, line 466
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/purecloudplatformclientv2/models/recording_job.rb, line 387
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 @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/recording_job.rb, line 376
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/purecloudplatformclientv2/models/recording_job.rb, line 382
def hash
  [id, state, recording_jobs_query, date_created, total_conversations, total_recordings, total_processed_recordings, percent_progress, error_message, self_uri, user].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/purecloudplatformclientv2/models/recording_job.rb, line 224
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
state=(state) click to toggle source

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

# File lib/purecloudplatformclientv2/models/recording_job.rb, line 300
def state=(state)
  allowed_values = ["FULFILLED", "PENDING", "READY", "PROCESSING", "CANCELLED", "FAILED"]
  if state && !allowed_values.include?(state)
    fail ArgumentError, "invalid value for 'state', must be one of #{allowed_values}."
  end
  @state = state
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/recording_job.rb, line 449
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/recording_job.rb, line 454
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/purecloudplatformclientv2/models/recording_job.rb, line 444
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/purecloudplatformclientv2/models/recording_job.rb, line 233
def valid?
  
  
  
  
  
  
  if @state.nil?
    return false
  end

  
  
  allowed_values = ["FULFILLED", "PENDING", "READY", "PROCESSING", "CANCELLED", "FAILED"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end