class PureCloud::SegmentDetailQueryPredicate
Attributes
Left hand side for dimension predicates
Left hand side for metric predicates
Optional operator, default is matches
Left hand side for property predicates
Left hand side for property predicates
Right hand side for dimension, metric, or property predicates
Optional type, can usually be inferred
Right hand side for dimension, metric, or property predicates
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb, line 46 def self.attribute_map { :'type' => :'type', :'dimension' => :'dimension', :'property_type' => :'propertyType', :'property' => :'property', :'metric' => :'metric', :'operator' => :'operator', :'value' => :'value', :'range' => :'range' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb, line 93 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?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'dimension') self.dimension = attributes[:'dimension'] end if attributes.has_key?(:'propertyType') self.property_type = attributes[:'propertyType'] end if attributes.has_key?(:'property') self.property = attributes[:'property'] end if attributes.has_key?(:'metric') self.metric = attributes[:'metric'] 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 end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb, line 69 def self.swagger_types { :'type' => :'String', :'dimension' => :'String', :'property_type' => :'String', :'property' => :'String', :'metric' => :'String', :'operator' => :'String', :'value' => :'String', :'range' => :'NumericRange' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb, line 334 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && dimension == o.dimension && property_type == o.property_type && property == o.property && metric == o.metric && operator == o.operator && value == o.value && range == o.range end
# File lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb, line 379 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/segment_detail_query_predicate.rb, line 439 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/segment_detail_query_predicate.rb, line 360 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/segment_detail_query_predicate.rb, line 264 def dimension=(dimension) allowed_values = ["addressFrom", "addressOther", "addressSelf", "addressTo", "agentAssistantId", "agentRank", "agentScore", "ani", "audioMuted", "callbackNumber", "callbackScheduledTime", "callbackUserName", "cobrowseRole", "cobrowseRoomId", "conference", "destinationConversationId", "destinationSessionId", "direction", "disconnectType", "dispositionAnalyzer", "dispositionName", "dnis", "edgeId", "endingLanguage", "entryReason", "entryType", "errorCode", "exitReason", "externalContactId", "externalOrganizationId", "flaggedReason", "flowId", "flowName", "flowOutType", "flowOutcome", "flowOutcomeEndTimestamp", "flowOutcomeId", "flowOutcomeStartTimestamp", "flowOutcomeValue", "flowType", "flowVersion", "groupId", "issuedCallback", "journeyActionId", "journeyActionMapId", "journeyActionMapVersion", "journeyCustomerId", "journeyCustomerIdType", "journeyCustomerSessionId", "journeyCustomerSessionIdType", "journeySegmentScope", "mediaBridgeId", "mediaCount", "mediaType", "messageType", "monitoredParticipantId", "outboundCampaignId", "outboundContactId", "outboundContactListId", "participantId", "participantName", "peerId", "proposedAgentId", "protocolCallId", "provider", "purpose", "q850ResponseCode", "queueId", "recording", "remote", "remoteNameDisplayable", "requestedLanguageId", "requestedRouting", "requestedRoutingSkillId", "requestedRoutingUserId", "roomId", "scoredAgentId", "screenShareAddressSelf", "screenShareRoomId", "scriptId", "segmentEnd", "segmentType", "selectedAgentId", "selectedAgentRank", "sessionDnis", "sessionId", "sharingScreen", "sipResponseCode", "skipEnabled", "sourceConversationId", "sourceSessionId", "startingLanguage", "subject", "teamId", "timeoutSeconds", "transferTargetAddress", "transferTargetName", "transferType", "usedRouting", "userId", "videoAddressSelf", "videoMuted", "videoRoomId", "wrapUpCode", "wrapUpNote", "wrapUpTag"] 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/segment_detail_query_predicate.rb, line 349 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb, line 355 def hash [type, dimension, property_type, property, metric, operator, value, range].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/segment_detail_query_predicate.rb, line 176 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] metric Object to be assigned
# File lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb, line 297 def metric=(metric) allowed_values = ["tSegmentDuration"] 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] operator Object to be assigned
# File lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb, line 311 def operator=(operator) allowed_values = ["matches", "exists", "notExists"] if operator && !allowed_values.include?(operator) fail ArgumentError, "invalid value for 'operator', must be one of #{allowed_values}." end @operator = operator end
Custom attribute writer method checking allowed values (enum). @param [Object] property_type
Object to be assigned
# File lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb, line 278 def property_type=(property_type) allowed_values = ["bool", "integer", "real", "date", "string", "uuid"] if property_type && !allowed_values.include?(property_type) fail ArgumentError, "invalid value for 'property_type', must be one of #{allowed_values}." end @property_type = property_type end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb, line 427 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/segment_detail_query_predicate.rb, line 417 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb, line 250 def type=(type) allowed_values = ["dimension", "property", "metric"] if type && !allowed_values.include?(type) fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}." end @type = type 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/segment_detail_query_predicate.rb, line 185 def valid? allowed_values = ["dimension", "property", "metric"] if @type && !allowed_values.include?(@type) return false end allowed_values = ["addressFrom", "addressOther", "addressSelf", "addressTo", "agentAssistantId", "agentRank", "agentScore", "ani", "audioMuted", "callbackNumber", "callbackScheduledTime", "callbackUserName", "cobrowseRole", "cobrowseRoomId", "conference", "destinationConversationId", "destinationSessionId", "direction", "disconnectType", "dispositionAnalyzer", "dispositionName", "dnis", "edgeId", "endingLanguage", "entryReason", "entryType", "errorCode", "exitReason", "externalContactId", "externalOrganizationId", "flaggedReason", "flowId", "flowName", "flowOutType", "flowOutcome", "flowOutcomeEndTimestamp", "flowOutcomeId", "flowOutcomeStartTimestamp", "flowOutcomeValue", "flowType", "flowVersion", "groupId", "issuedCallback", "journeyActionId", "journeyActionMapId", "journeyActionMapVersion", "journeyCustomerId", "journeyCustomerIdType", "journeyCustomerSessionId", "journeyCustomerSessionIdType", "journeySegmentScope", "mediaBridgeId", "mediaCount", "mediaType", "messageType", "monitoredParticipantId", "outboundCampaignId", "outboundContactId", "outboundContactListId", "participantId", "participantName", "peerId", "proposedAgentId", "protocolCallId", "provider", "purpose", "q850ResponseCode", "queueId", "recording", "remote", "remoteNameDisplayable", "requestedLanguageId", "requestedRouting", "requestedRoutingSkillId", "requestedRoutingUserId", "roomId", "scoredAgentId", "screenShareAddressSelf", "screenShareRoomId", "scriptId", "segmentEnd", "segmentType", "selectedAgentId", "selectedAgentRank", "sessionDnis", "sessionId", "sharingScreen", "sipResponseCode", "skipEnabled", "sourceConversationId", "sourceSessionId", "startingLanguage", "subject", "teamId", "timeoutSeconds", "transferTargetAddress", "transferTargetName", "transferType", "usedRouting", "userId", "videoAddressSelf", "videoMuted", "videoRoomId", "wrapUpCode", "wrapUpNote", "wrapUpTag"] if @dimension && !allowed_values.include?(@dimension) return false end allowed_values = ["bool", "integer", "real", "date", "string", "uuid"] if @property_type && !allowed_values.include?(@property_type) return false end allowed_values = ["tSegmentDuration"] if @metric && !allowed_values.include?(@metric) return false end allowed_values = ["matches", "exists", "notExists"] if @operator && !allowed_values.include?(@operator) return false end end