class PureCloud::ContactListFilterPredicate
Attributes
Contact
list column from the ContactListFilter's contactList.
The type of data in the contact column.
Inverts the result of the predicate (i.e., if the predicate returns true, inverting it will return false).
The operator for this ContactListFilterPredicate
.
A range of values. Required for operators BETWEEN and IN.
Value with which to compare the contact's data. This could be text, a number, or a relative time. A value for relative time should follow the format PxxDTyyHzzM, where xx, yy, and zz specify the days, hours and minutes. For example, a value of P01DT08H30M corresponds to 1 day, 8 hours, and 30 minutes from now. To specify a time in the past, include a negative sign before each numeric value. For example, a value of P-01DT-08H-30M corresponds to 1 day, 8 hours, and 30 minutes in the past. You can also do things like P01DT00H-30M, which would correspond to 23 hours and 30 minutes from now (1 day - 30 minutes).
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb, line 40 def self.attribute_map { :'column' => :'column', :'column_type' => :'columnType', :'operator' => :'operator', :'value' => :'value', :'range' => :'range', :'inverted' => :'inverted' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb, line 79 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?(:'column') self.column = attributes[:'column'] end if attributes.has_key?(:'columnType') self.column_type = attributes[:'columnType'] end if attributes.has_key?(:'operator') self.operator = attributes[:'operator'] end if attributes.has_key?(:'value') self.value = attributes[:'value'] end if attributes.has_key?(:'range') self.range = attributes[:'range'] end if attributes.has_key?(:'inverted') self.inverted = attributes[:'inverted'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb, line 59 def self.swagger_types { :'column' => :'String', :'column_type' => :'String', :'operator' => :'String', :'value' => :'String', :'range' => :'ContactListFilterRange', :'inverted' => :'BOOLEAN' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb, line 242 def ==(o) return true if self.equal?(o) self.class == o.class && column == o.column && column_type == o.column_type && operator == o.operator && value == o.value && range == o.range && inverted == o.inverted end
# File lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb, line 285 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/contact_list_filter_predicate.rb, line 345 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/contact_list_filter_predicate.rb, line 266 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] column_type
Object to be assigned
# File lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb, line 200 def column_type=(column_type) allowed_values = ["numeric", "alphabetic"] if column_type && !allowed_values.include?(column_type) fail ArgumentError, "invalid value for 'column_type', must be one of #{allowed_values}." end @column_type = column_type end
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb, line 255 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb, line 261 def hash [column, column_type, operator, value, range, inverted].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/contact_list_filter_predicate.rb, line 144 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] operator Object to be assigned
# File lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb, line 214 def operator=(operator) allowed_values = ["EQUALS", "LESS_THAN", "LESS_THAN_EQUALS", "GREATER_THAN", "GREATER_THAN_EQUALS", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "BEFORE", "AFTER", "BETWEEN", "IN"] if operator && !allowed_values.include?(operator) fail ArgumentError, "invalid value for 'operator', must be one of #{allowed_values}." end @operator = operator end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/contact_list_filter_predicate.rb, line 333 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/contact_list_filter_predicate.rb, line 323 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/contact_list_filter_predicate.rb, line 153 def valid? allowed_values = ["numeric", "alphabetic"] if @column_type && !allowed_values.include?(@column_type) return false end allowed_values = ["EQUALS", "LESS_THAN", "LESS_THAN_EQUALS", "GREATER_THAN", "GREATER_THAN_EQUALS", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "BEFORE", "AFTER", "BETWEEN", "IN"] if @operator && !allowed_values.include?(@operator) return false end end