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/purecloudplatformclientv2/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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/interaction_stats_rule.rb, line 135 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?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'dimension') self.dimension = attributes[:'dimension'] end if attributes.has_key?(:'dimensionValue') self.dimension_value = attributes[:'dimensionValue'] end if attributes.has_key?(:'metric') self.metric = attributes[:'metric'] end if attributes.has_key?(:'mediaType') self.media_type = attributes[:'mediaType'] end if attributes.has_key?(:'numericRange') self.numeric_range = attributes[:'numericRange'] end if attributes.has_key?(:'statistic') self.statistic = attributes[:'statistic'] end if attributes.has_key?(:'value') self.value = attributes[:'value'] end if attributes.has_key?(:'enabled') self.enabled = attributes[:'enabled'] end if attributes.has_key?(:'inAlarm') self.in_alarm = attributes[:'inAlarm'] end if attributes.has_key?(:'notificationUsers') if (value = attributes[:'notificationUsers']).is_a?(Array) self.notification_users = value end end if attributes.has_key?(:'alertTypes') if (value = attributes[:'alertTypes']).is_a?(Array) self.alert_types = value end end if attributes.has_key?(:'selfUri') self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/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
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/interaction_stats_rule.rb, line 543 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/purecloudplatformclientv2/models/interaction_stats_rule.rb, line 594 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/purecloudplatformclientv2/models/interaction_stats_rule.rb, line 654 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/purecloudplatformclientv2/models/interaction_stats_rule.rb, line 575 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). @param [Object] dimension Object to be assigned
# File lib/purecloudplatformclientv2/models/interaction_stats_rule.rb, line 439 def dimension=(dimension) allowed_values = ["queueId", "userId"] if dimension && !allowed_values.include?(dimension) fail ArgumentError, "invalid value for 'dimension', must be one of #{allowed_values}." end @dimension = dimension end
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/interaction_stats_rule.rb, line 564 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/interaction_stats_rule.rb, line 570 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/interaction_stats_rule.rb, line 276 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] media_type
Object to be assigned
# File lib/purecloudplatformclientv2/models/interaction_stats_rule.rb, line 472 def media_type=(media_type) allowed_values = ["voice", "chat", "email", "callback", "message"] if media_type && !allowed_values.include?(media_type) fail ArgumentError, "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). @param [Object] metric Object to be assigned
# File lib/purecloudplatformclientv2/models/interaction_stats_rule.rb, line 458 def metric=(metric) allowed_values = ["tAbandon", "tAnswered", "tTalk", "nOffered", "tHandle", "nTransferred", "oServiceLevel", "tWait", "tHeld", "tAcw"] if metric && !allowed_values.include?(metric) fail ArgumentError, "invalid value for 'metric', must be one of #{allowed_values}." end @metric = metric end
Custom attribute writer method checking allowed values (enum). @param [Object] numeric_range
Object to be assigned
# File lib/purecloudplatformclientv2/models/interaction_stats_rule.rb, line 486 def numeric_range=(numeric_range) allowed_values = ["gt", "gte", "lt", "lte", "eq", "ne"] if numeric_range && !allowed_values.include?(numeric_range) fail ArgumentError, "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). @param [Object] statistic Object to be assigned
# File lib/purecloudplatformclientv2/models/interaction_stats_rule.rb, line 500 def statistic=(statistic) allowed_values = ["count", "min", "ratio", "max"] if statistic && !allowed_values.include?(statistic) fail ArgumentError, "invalid value for 'statistic', must be one of #{allowed_values}." end @statistic = statistic end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/interaction_stats_rule.rb, line 642 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/purecloudplatformclientv2/models/interaction_stats_rule.rb, line 632 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/purecloudplatformclientv2/models/interaction_stats_rule.rb, line 285 def valid? if @name.nil? return false end if @dimension.nil? return false end allowed_values = ["queueId", "userId"] if @dimension && !allowed_values.include?(@dimension) return false end if @dimension_value.nil? return false end if @metric.nil? return false end allowed_values = ["tAbandon", "tAnswered", "tTalk", "nOffered", "tHandle", "nTransferred", "oServiceLevel", "tWait", "tHeld", "tAcw"] if @metric && !allowed_values.include?(@metric) return false end if @media_type.nil? return false end allowed_values = ["voice", "chat", "email", "callback", "message"] if @media_type && !allowed_values.include?(@media_type) return false end if @numeric_range.nil? return false end allowed_values = ["gt", "gte", "lt", "lte", "eq", "ne"] if @numeric_range && !allowed_values.include?(@numeric_range) return false end if @statistic.nil? return false end allowed_values = ["count", "min", "ratio", "max"] if @statistic && !allowed_values.include?(@statistic) return false end if @value.nil? return false end if @enabled.nil? return false end if @notification_users.nil? return false end if @alert_types.nil? return false end end