Class: PureCloud::AnalyticsQueryPredicate

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/analytics_query_predicate.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyticsQueryPredicate

Returns a new instance of AnalyticsQueryPredicate.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/purecloud/models/analytics_query_predicate.rb', line 83

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[:'type']
    self.type = attributes[:'type']
  end
  
  if attributes[:'dimension']
    self.dimension = attributes[:'dimension']
  end
  
  if attributes[:'propertyType']
    self.property_type = attributes[:'propertyType']
  end
  
  if attributes[:'property']
    self.property = attributes[:'property']
  end
  
  if attributes[:'metric']
    self.metric = attributes[:'metric']
  end
  
  if attributes[:'operator']
    self.operator = attributes[:'operator']
  end
  
  if attributes[:'value']
    self.value = attributes[:'value']
  end
  
  if attributes[:'range']
    self.range = attributes[:'range']
  end
  
end

Instance Attribute Details

#dimensionObject

Left hand side for dimension predicates



25
26
27
# File 'lib/purecloud/models/analytics_query_predicate.rb', line 25

def dimension
  @dimension
end

#metricObject

Left hand side for metric predicates



34
35
36
# File 'lib/purecloud/models/analytics_query_predicate.rb', line 34

def metric
  @metric
end

#operatorObject

Optional operator, default is matches



37
38
39
# File 'lib/purecloud/models/analytics_query_predicate.rb', line 37

def operator
  @operator
end

#propertyObject

Left hand side for property predicates



31
32
33
# File 'lib/purecloud/models/analytics_query_predicate.rb', line 31

def property
  @property
end

#property_typeObject

Left hand side for property predicates



28
29
30
# File 'lib/purecloud/models/analytics_query_predicate.rb', line 28

def property_type
  @property_type
end

#rangeObject

Right hand side for property or metric predicates



43
44
45
# File 'lib/purecloud/models/analytics_query_predicate.rb', line 43

def range
  @range
end

#typeObject

Optional type, can usually be inferred



22
23
24
# File 'lib/purecloud/models/analytics_query_predicate.rb', line 22

def type
  @type
end

#valueObject

Right hand side for dimension, property, or metric predicates



40
41
42
# File 'lib/purecloud/models/analytics_query_predicate.rb', line 40

def value
  @value
end

Class Method Details

.attribute_mapObject

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# File 'lib/purecloud/models/analytics_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

.swagger_typesObject

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/purecloud/models/analytics_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

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/purecloud/models/analytics_query_predicate.rb', line 170

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

#_deserialize(type, value) ⇒ Object



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
# File 'lib/purecloud/models/analytics_query_predicate.rb', line 213

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) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



273
274
275
276
277
278
279
280
281
282
283
284
285
# File 'lib/purecloud/models/analytics_query_predicate.rb', line 273

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) ⇒ Object

build the object from hash



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'lib/purecloud/models/analytics_query_predicate.rb', line 194

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) ⇒ Boolean

Returns:

  • (Boolean)

See Also:

  • `==` method


184
185
186
# File 'lib/purecloud/models/analytics_query_predicate.rb', line 184

def eql?(o)
  self == o
end

#hashObject

Calculate hash code according to all attributes.



189
190
191
# File 'lib/purecloud/models/analytics_query_predicate.rb', line 189

def hash
  [type, dimension, property_type, property, metric, operator, value, range].hash
end

#to_bodyObject

to_body is an alias to to_body (backward compatibility))



256
257
258
# File 'lib/purecloud/models/analytics_query_predicate.rb', line 256

def to_body
  to_hash
end

#to_hashObject

return the object in the form of hash



261
262
263
264
265
266
267
268
269
# File 'lib/purecloud/models/analytics_query_predicate.rb', line 261

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_sObject



251
252
253
# File 'lib/purecloud/models/analytics_query_predicate.rb', line 251

def to_s
  to_hash.to_s
end