Class: PureCloud::FlowAggregationQuery

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/flow_aggregation_query.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FlowAggregationQuery

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
127
128
129
130
131
132
133
134
135
136
137
138
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 100

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#alternate_time_dimension ⇒ Object

Dimension to use as the alternative timestamp for data in the aggregate. Choosing "eventTime" uses the actual time of the data event.



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 46

def alternate_time_dimension
  @alternate_time_dimension
end

#filter ⇒ Object

Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 34

def filter
  @filter
end

#flatten_multivalued_dimensions ⇒ Object

Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 40

def flatten_multivalued_dimensions
  @flatten_multivalued_dimensions
end

#granularity ⇒ Object

Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 25

def granularity
  @granularity
end

#group_by ⇒ Object

Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 31

def group_by
  @group_by
end

#interval ⇒ Object

Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 22

def interval
  @interval
end

#metrics ⇒ Object

Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *).



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 37

def metrics
  @metrics
end

#time_zone ⇒ Object

Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 28

def time_zone
  @time_zone
end

#views ⇒ Object

Custom derived metric views



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 43

def views
  @views
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 49

def self.attribute_map
  {
    
    :'interval' => :'interval',
    
    :'granularity' => :'granularity',
    
    :'time_zone' => :'timeZone',
    
    :'group_by' => :'groupBy',
    
    :'filter' => :'filter',
    
    :'metrics' => :'metrics',
    
    :'flatten_multivalued_dimensions' => :'flattenMultivaluedDimensions',
    
    :'views' => :'views',
    
    :'alternate_time_dimension' => :'alternateTimeDimension'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 74

def self.swagger_types
  {
    
    :'interval' => :'String',
    
    :'granularity' => :'String',
    
    :'time_zone' => :'String',
    
    :'group_by' => :'Array<String>',
    
    :'filter' => :'FlowAggregateQueryFilter',
    
    :'metrics' => :'Array<String>',
    
    :'flatten_multivalued_dimensions' => :'BOOLEAN',
    
    :'views' => :'Array<FlowAggregationView>',
    
    :'alternate_time_dimension' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 314

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      interval == o.interval &&
      granularity == o.granularity &&
      time_zone == o.time_zone &&
      group_by == o.group_by &&
      filter == o.filter &&
      metrics == o.metrics &&
      flatten_multivalued_dimensions == o.flatten_multivalued_dimensions &&
      views == o.views &&
      alternate_time_dimension == o.alternate_time_dimension
end

#_deserialize(type, value) ⇒ Object 



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 360

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



420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 420

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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 341

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


330
331
332
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 330

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



336
337
338
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 336

def hash
  [interval, granularity, time_zone, group_by, filter, metrics, flatten_multivalued_dimensions, views, alternate_time_dimension].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



198
199
200
201
202
203
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 198

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



403
404
405
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 403

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



408
409
410
411
412
413
414
415
416
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 408

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 



398
399
400
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 398

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



207
208
209
210
211
212
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
250
251
252
253
254
255
 
# File 'lib/purecloudplatformclientv2/models/flow_aggregation_query.rb', line 207

def valid?
  
  
  if @interval.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["eventTime"]
  if @alternate_time_dimension && !allowed_values.include?(@alternate_time_dimension)
    return false
  end
  
  
  
end