class PureCloud::ReportSchedule

Attributes

date_created[RW]

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

date_modified[RW]

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

description[RW]
enabled[RW]
id[RW]

The globally unique identifier for the object.

interval[RW]

Interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss

last_run[RW]
locale[RW]
name[RW]
next_fire_time[RW]

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

parameters[RW]
quartz_cron_expression[RW]

Quartz Cron Expression

report_format[RW]
report_id[RW]

Report ID

self_uri[RW]

The URI for this object

time_period[RW]
time_zone[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/report_schedule.rb, line 64
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'quartz_cron_expression' => :'quartzCronExpression',
    
    :'next_fire_time' => :'nextFireTime',
    
    :'date_created' => :'dateCreated',
    
    :'date_modified' => :'dateModified',
    
    :'description' => :'description',
    
    :'time_zone' => :'timeZone',
    
    :'time_period' => :'timePeriod',
    
    :'interval' => :'interval',
    
    :'report_format' => :'reportFormat',
    
    :'locale' => :'locale',
    
    :'enabled' => :'enabled',
    
    :'report_id' => :'reportId',
    
    :'parameters' => :'parameters',
    
    :'last_run' => :'lastRun',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/report_schedule.rb, line 128
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[:'quartzCronExpression']
    self.quartz_cron_expression = attributes[:'quartzCronExpression']
  end
  
  if attributes[:'nextFireTime']
    self.next_fire_time = attributes[:'nextFireTime']
  end
  
  if attributes[:'dateCreated']
    self.date_created = attributes[:'dateCreated']
  end
  
  if attributes[:'dateModified']
    self.date_modified = attributes[:'dateModified']
  end
  
  if attributes[:'description']
    self.description = attributes[:'description']
  end
  
  if attributes[:'timeZone']
    self.time_zone = attributes[:'timeZone']
  end
  
  if attributes[:'timePeriod']
    self.time_period = attributes[:'timePeriod']
  end
  
  if attributes[:'interval']
    self.interval = attributes[:'interval']
  end
  
  if attributes[:'reportFormat']
    self.report_format = attributes[:'reportFormat']
  end
  
  if attributes[:'locale']
    self.locale = attributes[:'locale']
  end
  
  if attributes[:'enabled']
    self.enabled = attributes[:'enabled']
  end
  
  if attributes[:'reportId']
    self.report_id = attributes[:'reportId']
  end
  
  if attributes[:'parameters']
    if (value = attributes[:'parameters']).is_a?(Array)
      self.parameters = value
    end
  end
  
  if attributes[:'lastRun']
    self.last_run = attributes[:'lastRun']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/report_schedule.rb, line 105
def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'quartz_cron_expression' => :'String',
    :'next_fire_time' => :'DateTime',
    :'date_created' => :'DateTime',
    :'date_modified' => :'DateTime',
    :'description' => :'String',
    :'time_zone' => :'String',
    :'time_period' => :'String',
    :'interval' => :'String',
    :'report_format' => :'String',
    :'locale' => :'String',
    :'enabled' => :'BOOLEAN',
    :'report_id' => :'String',
    :'parameters' => :'Hash<String, Object>',
    :'last_run' => :'ReportRunEntry',
    :'self_uri' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/report_schedule.rb, line 208
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      quartz_cron_expression == o.quartz_cron_expression &&
      next_fire_time == o.next_fire_time &&
      date_created == o.date_created &&
      date_modified == o.date_modified &&
      description == o.description &&
      time_zone == o.time_zone &&
      time_period == o.time_period &&
      interval == o.interval &&
      report_format == o.report_format &&
      locale == o.locale &&
      enabled == o.enabled &&
      report_id == o.report_id &&
      parameters == o.parameters &&
      last_run == o.last_run &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/report_schedule.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/purecloud/models/report_schedule.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
build_from_hash(attributes) click to toggle source

build the object from hash

# File lib/purecloud/models/report_schedule.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

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

Calculate hash code according to all attributes.

# File lib/purecloud/models/report_schedule.rb, line 236
def hash
  [id, name, quartz_cron_expression, next_fire_time, date_created, date_modified, description, time_zone, time_period, interval, report_format, locale, enabled, report_id, parameters, last_run, self_uri].hash
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

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