Class: PureCloud::AnalyticsQueryAggregation

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/analytics_query_aggregation.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyticsQueryAggregation

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



72
73
74
75
76
77
78
79
80
81
82
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
123
124
125
126
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 72

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?(:'metric')
    
    
    self.metric = attributes[:'metric']
    
  
  end

  
  if attributes.has_key?(:'size')
    
    
    self.size = attributes[:'size']
    
  
  end

  
  if attributes.has_key?(:'ranges')
    
    if (value = attributes[:'ranges']).is_a?(Array)
      self.ranges = value
    end
    
    
  
  end

  
end

Instance Attribute Details

#dimension ⇒ Object

For use with termFrequency aggregations



25
26
27
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 25

def dimension
  @dimension
end

#metric ⇒ Object

For use with numericRange aggregations



28
29
30
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 28

def metric
  @metric
end

#ranges ⇒ Object

For use with numericRange aggregations



34
35
36
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 34

def ranges
  @ranges
end

#size ⇒ Object

For use with termFrequency aggregations



31
32
33
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 31

def size
  @size
end

#type ⇒ Object

Optional type, can usually be inferred



22
23
24
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 22

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 37

def self.attribute_map
  {
    
    :'type' => :'type',
    
    :'dimension' => :'dimension',
    
    :'metric' => :'metric',
    
    :'size' => :'size',
    
    :'ranges' => :'ranges'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 54

def self.swagger_types
  {
    
    :'type' => :'String',
    
    :'dimension' => :'String',
    
    :'metric' => :'String',
    
    :'size' => :'Integer',
    
    :'ranges' => :'Array<AggregationRange>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



205
206
207
208
209
210
211
212
213
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 205

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      dimension == o.dimension &&
      metric == o.metric &&
      size == o.size &&
      ranges == o.ranges
end

#_deserialize(type, value) ⇒ Object 



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 247

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



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 307

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 228

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


217
218
219
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 217

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



223
224
225
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 223

def hash
  [type, dimension, metric, size, ranges].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



130
131
132
133
134
135
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 130

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



290
291
292
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 290

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



295
296
297
298
299
300
301
302
303
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 295

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



285
286
287
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 285

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/purecloudclient_v2a/models/analytics_query_aggregation.rb', line 139

def valid?
  
  
  
  allowed_values = ["termFrequency", "numericRange"]
  if @type && !allowed_values.include?(@type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end