class PureCloud::InteractionStatsRule
Attributes
A collection of notification methods.
The dimension of concern.
The value of the dimension.
Indicates if the rule is enabled.
The globally unique identifier for the object.
Indicates if the rule is in alarm state.
The media type.
The metric to be assessed.
Name of the rule
The ids of users who will be notified of alarm state change.
The comparison descriptor used against the metric's value.
The URI for this object
The statistic of concern for the metric.
The threshold value.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloud/models/interaction_stats_rule.rb, line 64 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'dimension' => :'dimension', :'dimension_value' => :'dimensionValue', :'metric' => :'metric', :'media_type' => :'mediaType', :'numeric_range' => :'numericRange', :'statistic' => :'statistic', :'value' => :'value', :'enabled' => :'enabled', :'in_alarm' => :'inAlarm', :'notification_users' => :'notificationUsers', :'alert_types' => :'alertTypes', :'self_uri' => :'selfUri' } end
# File lib/purecloud/models/interaction_stats_rule.rb, line 119 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[:'dimension'] self.dimension = attributes[:'dimension'] end if attributes[:'dimensionValue'] self.dimension_value = attributes[:'dimensionValue'] end if attributes[:'metric'] self.metric = attributes[:'metric'] end if attributes[:'mediaType'] self.media_type = attributes[:'mediaType'] end if attributes[:'numericRange'] self.numeric_range = attributes[:'numericRange'] end if attributes[:'statistic'] self.statistic = attributes[:'statistic'] end if attributes[:'value'] self.value = attributes[:'value'] end if attributes[:'enabled'] self.enabled = attributes[:'enabled'] end if attributes[:'inAlarm'] self.in_alarm = attributes[:'inAlarm'] end if attributes[:'notificationUsers'] if (value = attributes[:'notificationUsers']).is_a?(Array) self.notification_users = value end end if attributes[:'alertTypes'] if (value = attributes[:'alertTypes']).is_a?(Array) self.alert_types = value end end if attributes[:'selfUri'] self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloud/models/interaction_stats_rule.rb, line 99 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'dimension' => :'String', :'dimension_value' => :'String', :'metric' => :'String', :'media_type' => :'String', :'numeric_range' => :'String', :'statistic' => :'String', :'value' => :'Float', :'enabled' => :'BOOLEAN', :'in_alarm' => :'BOOLEAN', :'notification_users' => :'Array<User>', :'alert_types' => :'Array<String>', :'self_uri' => :'String' } end
Public Instance Methods
Check equality by comparing each attribute.
# File lib/purecloud/models/interaction_stats_rule.rb, line 234 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && dimension == o.dimension && dimension_value == o.dimension_value && metric == o.metric && media_type == o.media_type && numeric_range == o.numeric_range && statistic == o.statistic && value == o.value && enabled == o.enabled && in_alarm == o.in_alarm && notification_users == o.notification_users && alert_types == o.alert_types && self_uri == o.self_uri end
# File lib/purecloud/models/interaction_stats_rule.rb, line 283 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
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/interaction_stats_rule.rb, line 343 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 the object from hash
# File lib/purecloud/models/interaction_stats_rule.rb, line 264 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
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/interaction_stats_rule.rb, line 189 def dimension=(dimension) allowed_values = ["queueId", "userId"] if dimension && !allowed_values.include?(dimension) fail "invalid value for 'dimension', must be one of #{allowed_values}" end @dimension = dimension end
@see the `==` method
# File lib/purecloud/models/interaction_stats_rule.rb, line 254 def eql?(o) self == o end
Calculate hash code according to all attributes.
# File lib/purecloud/models/interaction_stats_rule.rb, line 259 def hash [id, name, dimension, dimension_value, metric, media_type, numeric_range, statistic, value, enabled, in_alarm, notification_users, alert_types, self_uri].hash end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/interaction_stats_rule.rb, line 207 def media_type=(media_type) allowed_values = ["voice", "chat", "email"] if media_type && !allowed_values.include?(media_type) fail "invalid value for 'media_type', must be one of #{allowed_values}" end @media_type = media_type end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/interaction_stats_rule.rb, line 198 def metric=(metric) allowed_values = ["tAbandon", "tAnswered", "tTalk", "nOffered", "tHandle", "nTransferred", "oServiceLevel", "tWait", "tHeld", "tAcw"] if metric && !allowed_values.include?(metric) fail "invalid value for 'metric', must be one of #{allowed_values}" end @metric = metric end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/interaction_stats_rule.rb, line 216 def numeric_range=(numeric_range) allowed_values = ["gt", "gte", "lt", "lte", "eq", "ne"] if numeric_range && !allowed_values.include?(numeric_range) fail "invalid value for 'numeric_range', must be one of #{allowed_values}" end @numeric_range = numeric_range end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/interaction_stats_rule.rb, line 225 def statistic=(statistic) allowed_values = ["count", "min", "ratio", "max"] if statistic && !allowed_values.include?(statistic) fail "invalid value for 'statistic', must be one of #{allowed_values}" end @statistic = statistic end
return the object in the form of hash
# File lib/purecloud/models/interaction_stats_rule.rb, line 331 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
# File lib/purecloud/models/interaction_stats_rule.rb, line 321 def to_s to_hash.to_s end