class PureCloud::BuScheduleRun

Attributes

id[RW]

The globally unique identifier for the object.

intraday_rescheduling[RW]

Whether this is an intraday rescheduling run

message_count[RW]

The number of schedule generation messages for this schedule generation run

percent_complete[RW]

Percent completion of the schedule run

rescheduling_options[RW]

Rescheduling options for this run. Null unless intradayRescheduling is true

rescheduling_result_expiration[RW]

When the reschedule result will expire. Null unless intradayRescheduling is true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

schedule[RW]

The generated schedule. Null unless the schedule run is complete

schedule_description[RW]

The description of the generated schedule

scheduler_run_id[RW]

The scheduler run ID. Reference this value for support

scheduling_canceled_by[RW]

The user who canceled the scheduling run, if applicable

scheduling_completed_time[RW]

When the scheduling run was completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

scheduling_start_time[RW]

When the schedule generation run started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

scheduling_started_by[RW]

The user who started the scheduling run

self_uri[RW]

The URI for this object

state[RW]

The state of the generation run

target_week[RW]

The start date of the target week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd

week_count[RW]

The number of weeks spanned by the schedule

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/bu_schedule_run.rb, line 73
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'scheduler_run_id' => :'schedulerRunId',
    
    :'intraday_rescheduling' => :'intradayRescheduling',
    
    :'state' => :'state',
    
    :'week_count' => :'weekCount',
    
    :'percent_complete' => :'percentComplete',
    
    :'target_week' => :'targetWeek',
    
    :'schedule' => :'schedule',
    
    :'schedule_description' => :'scheduleDescription',
    
    :'scheduling_start_time' => :'schedulingStartTime',
    
    :'scheduling_started_by' => :'schedulingStartedBy',
    
    :'scheduling_canceled_by' => :'schedulingCanceledBy',
    
    :'scheduling_completed_time' => :'schedulingCompletedTime',
    
    :'message_count' => :'messageCount',
    
    :'rescheduling_options' => :'reschedulingOptions',
    
    :'rescheduling_result_expiration' => :'reschedulingResultExpiration',
    
    :'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/bu_schedule_run.rb, line 156
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?(:'schedulerRunId')
    
    
    self.scheduler_run_id = attributes[:'schedulerRunId']
    
  
  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?(:'percentComplete')
    
    
    self.percent_complete = attributes[:'percentComplete']
    
  
  end

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

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

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

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

  
  if attributes.has_key?(:'schedulingStartedBy')
    
    
    self.scheduling_started_by = attributes[:'schedulingStartedBy']
    
  
  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

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

  
  if attributes.has_key?(:'reschedulingResultExpiration')
    
    
    self.rescheduling_result_expiration = attributes[:'reschedulingResultExpiration']
    
  
  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/bu_schedule_run.rb, line 114
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'scheduler_run_id' => :'String',
    
    :'intraday_rescheduling' => :'BOOLEAN',
    
    :'state' => :'String',
    
    :'week_count' => :'Integer',
    
    :'percent_complete' => :'Float',
    
    :'target_week' => :'Date',
    
    :'schedule' => :'BuScheduleReference',
    
    :'schedule_description' => :'String',
    
    :'scheduling_start_time' => :'DateTime',
    
    :'scheduling_started_by' => :'UserReference',
    
    :'scheduling_canceled_by' => :'UserReference',
    
    :'scheduling_completed_time' => :'DateTime',
    
    :'message_count' => :'Integer',
    
    :'rescheduling_options' => :'ReschedulingOptionsRunResponse',
    
    :'rescheduling_result_expiration' => :'DateTime',
    
    :'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/bu_schedule_run.rb, line 503
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      scheduler_run_id == o.scheduler_run_id &&
      intraday_rescheduling == o.intraday_rescheduling &&
      state == o.state &&
      week_count == o.week_count &&
      percent_complete == o.percent_complete &&
      target_week == o.target_week &&
      schedule == o.schedule &&
      schedule_description == o.schedule_description &&
      scheduling_start_time == o.scheduling_start_time &&
      scheduling_started_by == o.scheduling_started_by &&
      scheduling_canceled_by == o.scheduling_canceled_by &&
      scheduling_completed_time == o.scheduling_completed_time &&
      message_count == o.message_count &&
      rescheduling_options == o.rescheduling_options &&
      rescheduling_result_expiration == o.rescheduling_result_expiration &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/bu_schedule_run.rb, line 557
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/bu_schedule_run.rb, line 617
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/bu_schedule_run.rb, line 538
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/bu_schedule_run.rb, line 527
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/bu_schedule_run.rb, line 533
def hash
  [id, scheduler_run_id, intraday_rescheduling, state, week_count, percent_complete, target_week, schedule, schedule_description, scheduling_start_time, scheduling_started_by, scheduling_canceled_by, scheduling_completed_time, message_count, rescheduling_options, rescheduling_result_expiration, 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/bu_schedule_run.rb, line 320
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/bu_schedule_run.rb, line 425
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/bu_schedule_run.rb, line 600
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

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