class PureCloud::AggregationQuery

Attributes

filter[RW]

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

flatten_multivalued_dimensions[RW]

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

granularity[RW]

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

group_by[RW]

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.

interval[RW]

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

metrics[RW]

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

time_zone[RW]

Sets the time zone for the query interval, defaults to UTC. Time zones are represented as an ISO-8601 string. For example: UTC, UTC+01:00, or Europe/London

views[RW]

Custom derived metric views

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/aggregation_query.rb, line 46
def self.attribute_map
  {
    
    :'interval' => :'interval',
    
    :'granularity' => :'granularity',
    
    :'time_zone' => :'timeZone',
    
    :'group_by' => :'groupBy',
    
    :'filter' => :'filter',
    
    :'metrics' => :'metrics',
    
    :'flatten_multivalued_dimensions' => :'flattenMultivaluedDimensions',
    
    :'views' => :'views'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/aggregation_query.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[:'interval']
    self.interval = attributes[:'interval']
  end
  
  if attributes[:'granularity']
    self.granularity = attributes[:'granularity']
  end
  
  if attributes[:'timeZone']
    self.time_zone = attributes[:'timeZone']
  end
  
  if attributes[:'groupBy']
    if (value = attributes[:'groupBy']).is_a?(Array)
      self.group_by = value
    end
  end
  
  if attributes[:'filter']
    self.filter = attributes[:'filter']
  end
  
  if attributes[:'metrics']
    if (value = attributes[:'metrics']).is_a?(Array)
      self.metrics = value
    end
  end
  
  if attributes[:'flattenMultivaluedDimensions']
    self.flatten_multivalued_dimensions = attributes[:'flattenMultivaluedDimensions']
  end
  
  if attributes[:'views']
    if (value = attributes[:'views']).is_a?(Array)
      self.views = value
    end
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/aggregation_query.rb, line 69
def self.swagger_types
  {
    :'interval' => :'String',
    :'granularity' => :'String',
    :'time_zone' => :'String',
    :'group_by' => :'Array<String>',
    :'filter' => :'AnalyticsQueryFilter',
    :'metrics' => :'Array<String>',
    :'flatten_multivalued_dimensions' => :'BOOLEAN',
    :'views' => :'Array<AnalyticsView>'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/aggregation_query.rb, line 131
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
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/aggregation_query.rb, line 174
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) click to toggle source

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

# File lib/purecloud/models/aggregation_query.rb, line 234
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) click to toggle source

build the object from hash

# File lib/purecloud/models/aggregation_query.rb, line 155
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) click to toggle source

@see the `==` method

# File lib/purecloud/models/aggregation_query.rb, line 145
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/aggregation_query.rb, line 150
def hash
  [interval, granularity, time_zone, group_by, filter, metrics, flatten_multivalued_dimensions, views].hash
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloud/models/aggregation_query.rb, line 217
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloud/models/aggregation_query.rb, line 222
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() click to toggle source
# File lib/purecloud/models/aggregation_query.rb, line 212
def to_s
  to_hash.to_s
end