class PureCloud::RecordingMetadata

Attributes

annotations[RW]

Annotations that belong to the recording. Populated when recording filestate is AVAILABLE.

archive_date[RW]

The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

archive_medium[RW]

The type of archive medium used. Example: CloudArchive

conversation_id[RW]
delete_date[RW]

The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

end_time[RW]
export_date[RW]

The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

exported_date[RW]

The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

file_state[RW]

Represents the current file state for a recording. Examples: Uploading, Archived, etc

id[RW]

The globally unique identifier for the object.

max_allowed_restorations_for_org[RW]

How many archive restorations the organization is allowed to have.

media[RW]

The type of media that the recording is. At the moment that could be audio, chat, email, or message.

name[RW]
path[RW]
remaining_restorations_allowed_for_org[RW]

The remaining archive restorations the organization has.

restore_expiration_time[RW]

The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

self_uri[RW]

The URI for this object

session_id[RW]

The session id represents an external resource id, such as email, call, chat, etc

start_time[RW]

The start time of the recording for screen recordings. Null for other types.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/recording_metadata.rb, line 75
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'conversation_id' => :'conversationId',
    
    :'path' => :'path',
    
    :'start_time' => :'startTime',
    
    :'end_time' => :'endTime',
    
    :'media' => :'media',
    
    :'annotations' => :'annotations',
    
    :'file_state' => :'fileState',
    
    :'restore_expiration_time' => :'restoreExpirationTime',
    
    :'archive_date' => :'archiveDate',
    
    :'archive_medium' => :'archiveMedium',
    
    :'delete_date' => :'deleteDate',
    
    :'export_date' => :'exportDate',
    
    :'exported_date' => :'exportedDate',
    
    :'max_allowed_restorations_for_org' => :'maxAllowedRestorationsForOrg',
    
    :'remaining_restorations_allowed_for_org' => :'remainingRestorationsAllowedForOrg',
    
    :'session_id' => :'sessionId',
    
    :'self_uri' => :'selfUri'
    
  }
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_metadata.rb, line 166
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?(:'name')
    
    
    self.name = attributes[:'name']
    
  
  end

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

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

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

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

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

  
  if attributes.has_key?(:'annotations')
    
    if (value = attributes[:'annotations']).is_a?(Array)
      self.annotations = value
    end
    
    
  
  end

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

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

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

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

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

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/recording_metadata.rb, line 120
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'conversation_id' => :'String',
    
    :'path' => :'String',
    
    :'start_time' => :'String',
    
    :'end_time' => :'String',
    
    :'media' => :'String',
    
    :'annotations' => :'Array<Annotation>',
    
    :'file_state' => :'String',
    
    :'restore_expiration_time' => :'DateTime',
    
    :'archive_date' => :'DateTime',
    
    :'archive_medium' => :'String',
    
    :'delete_date' => :'DateTime',
    
    :'export_date' => :'DateTime',
    
    :'exported_date' => :'DateTime',
    
    :'max_allowed_restorations_for_org' => :'Integer',
    
    :'remaining_restorations_allowed_for_org' => :'Integer',
    
    :'session_id' => :'String',
    
    :'self_uri' => :'String'
    
  }
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_metadata.rb, line 565
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      conversation_id == o.conversation_id &&
      path == o.path &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      media == o.media &&
      annotations == o.annotations &&
      file_state == o.file_state &&
      restore_expiration_time == o.restore_expiration_time &&
      archive_date == o.archive_date &&
      archive_medium == o.archive_medium &&
      delete_date == o.delete_date &&
      export_date == o.export_date &&
      exported_date == o.exported_date &&
      max_allowed_restorations_for_org == o.max_allowed_restorations_for_org &&
      remaining_restorations_allowed_for_org == o.remaining_restorations_allowed_for_org &&
      session_id == o.session_id &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/recording_metadata.rb, line 621
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_metadata.rb, line 681
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
archive_medium=(archive_medium) click to toggle source

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

# File lib/purecloudplatformclientv2/models/recording_metadata.rb, line 517
def archive_medium=(archive_medium)
  allowed_values = ["CLOUDARCHIVE"]
  if archive_medium && !allowed_values.include?(archive_medium)
    fail ArgumentError, "invalid value for 'archive_medium', must be one of #{allowed_values}."
  end
  @archive_medium = archive_medium
end
build_from_hash(attributes) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/recording_metadata.rb, line 602
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_metadata.rb, line 591
def eql?(o)
  self == o
end
file_state=(file_state) click to toggle source

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

# File lib/purecloudplatformclientv2/models/recording_metadata.rb, line 493
def file_state=(file_state)
  allowed_values = ["ARCHIVED", "AVAILABLE", "DELETED", "RESTORED", "RESTORING", "UPLOADING", "ERROR"]
  if file_state && !allowed_values.include?(file_state)
    fail ArgumentError, "invalid value for 'file_state', must be one of #{allowed_values}."
  end
  @file_state = file_state
end
hash() click to toggle source

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

# File lib/purecloudplatformclientv2/models/recording_metadata.rb, line 597
def hash
  [id, name, conversation_id, path, start_time, end_time, media, annotations, file_state, restore_expiration_time, archive_date, archive_medium, delete_date, export_date, exported_date, max_allowed_restorations_for_org, remaining_restorations_allowed_for_org, session_id, self_uri].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_metadata.rb, line 350
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/recording_metadata.rb, line 664
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_metadata.rb, line 669
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_metadata.rb, line 659
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_metadata.rb, line 359
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["ARCHIVED", "AVAILABLE", "DELETED", "RESTORED", "RESTORING", "UPLOADING", "ERROR"]
  if @file_state && !allowed_values.include?(@file_state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["CLOUDARCHIVE"]
  if @archive_medium && !allowed_values.include?(@archive_medium)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end