class PureCloud::WfmBuScheduleRunTopicBuScheduleRun

Attributes

id[RW]
intraday_rescheduling[RW]
message_count[RW]
percent_complete[RW]
schedule[RW]
scheduling_canceled_by[RW]
scheduling_completed_time[RW]
state[RW]
week_count[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/wfm_bu_schedule_run_topic_bu_schedule_run.rb, line 40
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'percent_complete' => :'percentComplete',
    
    :'intraday_rescheduling' => :'intradayRescheduling',
    
    :'state' => :'state',
    
    :'week_count' => :'weekCount',
    
    :'schedule' => :'schedule',
    
    :'scheduling_canceled_by' => :'schedulingCanceledBy',
    
    :'scheduling_completed_time' => :'schedulingCompletedTime',
    
    :'message_count' => :'messageCount'
    
  }
end
new(attributes = {}) click to toggle source

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

# File lib/purecloudplatformclientv2/models/wfm_bu_schedule_run_topic_bu_schedule_run.rb, line 91
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?(:'percentComplete')
    
    
    self.percent_complete = attributes[:'percentComplete']
    
  
  end

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

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/wfm_bu_schedule_run_topic_bu_schedule_run.rb, line 65
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'percent_complete' => :'Float',
    
    :'intraday_rescheduling' => :'BOOLEAN',
    
    :'state' => :'String',
    
    :'week_count' => :'Integer',
    
    :'schedule' => :'WfmBuScheduleRunTopicBuScheduleReference',
    
    :'scheduling_canceled_by' => :'WfmBuScheduleRunTopicUserReference',
    
    :'scheduling_completed_time' => :'String',
    
    :'message_count' => :'Integer'
    
  }
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/wfm_bu_schedule_run_topic_bu_schedule_run.rb, line 294
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      percent_complete == o.percent_complete &&
      intraday_rescheduling == o.intraday_rescheduling &&
      state == o.state &&
      week_count == o.week_count &&
      schedule == o.schedule &&
      scheduling_canceled_by == o.scheduling_canceled_by &&
      scheduling_completed_time == o.scheduling_completed_time &&
      message_count == o.message_count
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/wfm_bu_schedule_run_topic_bu_schedule_run.rb, line 340
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/wfm_bu_schedule_run_topic_bu_schedule_run.rb, line 400
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/wfm_bu_schedule_run_topic_bu_schedule_run.rb, line 321
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/wfm_bu_schedule_run_topic_bu_schedule_run.rb, line 310
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/wfm_bu_schedule_run_topic_bu_schedule_run.rb, line 316
def hash
  [id, percent_complete, intraday_rescheduling, state, week_count, schedule, scheduling_canceled_by, scheduling_completed_time, message_count].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/wfm_bu_schedule_run_topic_bu_schedule_run.rb, line 183
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/wfm_bu_schedule_run_topic_bu_schedule_run.rb, line 256
def state=(state)
  allowed_values = ["None", "Queued", "Scheduling", "Canceled", "Failed", "Complete"]
  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/wfm_bu_schedule_run_topic_bu_schedule_run.rb, line 383
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/wfm_bu_schedule_run_topic_bu_schedule_run.rb, line 388
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/wfm_bu_schedule_run_topic_bu_schedule_run.rb, line 378
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/wfm_bu_schedule_run_topic_bu_schedule_run.rb, line 192
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["None", "Queued", "Scheduling", "Canceled", "Failed", "Complete"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end