class PureCloud::RecordingJobsQuery

Attributes

action[RW]

Operation to perform bulk task

action_date[RW]

The date when the action will be performed. If the operation will cause the delete date of a recording to be older than the export date, the export date will be adjusted to the delete date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

conversation_query[RW]

Conversation Query. Note: After the recording is created, it might take up to 48 hours for the recording to be included in the submitted job query.

include_screen_recordings[RW]

Include Screen recordings for export action, default value = true

integration_id[RW]

IntegrationId to Access AWS S3 bucket for bulk recording exports. This field is required and used only for EXPORT action.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/recording_jobs_query.rb, line 37
def self.attribute_map
  {
    
    :'action' => :'action',
    
    :'action_date' => :'actionDate',
    
    :'integration_id' => :'integrationId',
    
    :'include_screen_recordings' => :'includeScreenRecordings',
    
    :'conversation_query' => :'conversationQuery'
    
  }
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_jobs_query.rb, line 72
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?(:'action')
    
    
    self.action = attributes[:'action']
    
  
  end

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/recording_jobs_query.rb, line 54
def self.swagger_types
  {
    
    :'action' => :'String',
    
    :'action_date' => :'DateTime',
    
    :'integration_id' => :'String',
    
    :'include_screen_recordings' => :'BOOLEAN',
    
    :'conversation_query' => :'AsyncConversationQuery'
    
  }
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_jobs_query.rb, line 218
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      action == o.action &&
      action_date == o.action_date &&
      integration_id == o.integration_id &&
      include_screen_recordings == o.include_screen_recordings &&
      conversation_query == o.conversation_query
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/recording_jobs_query.rb, line 260
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_jobs_query.rb, line 320
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=(action) click to toggle source

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

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

build the object from hash

# File lib/purecloudplatformclientv2/models/recording_jobs_query.rb, line 241
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_jobs_query.rb, line 230
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_jobs_query.rb, line 236
def hash
  [action, action_date, integration_id, include_screen_recordings, conversation_query].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_jobs_query.rb, line 128
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_jobs_query.rb, line 303
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_jobs_query.rb, line 308
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_jobs_query.rb, line 298
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_jobs_query.rb, line 137
def valid?
  
  
  if @action.nil?
    return false
  end

  
  
  allowed_values = ["DELETE", "EXPORT"]
  if @action && !allowed_values.include?(@action)
    return false
  end
  
  
  
  
  if @action_date.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  if @conversation_query.nil?
    return false
  end

  
  
  
  
end