class PureCloud::JourneyAggregationQuery

Attributes

alternate_time_dimension[RW]

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

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]

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

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/purecloudplatformclientv2/models/journey_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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/purecloudplatformclientv2/models/journey_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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/journey_aggregation_query.rb, line 74
def self.swagger_types
  {
    
    :'interval' => :'String',
    
    :'granularity' => :'String',
    
    :'time_zone' => :'String',
    
    :'group_by' => :'Array<String>',
    
    :'filter' => :'JourneyAggregateQueryFilter',
    
    :'metrics' => :'Array<String>',
    
    :'flatten_multivalued_dimensions' => :'BOOLEAN',
    
    :'views' => :'Array<JourneyAggregationView>',
    
    :'alternate_time_dimension' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/journey_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) click to toggle source
# File lib/purecloudplatformclientv2/models/journey_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) 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/purecloudplatformclientv2/models/journey_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
alternate_time_dimension=(alternate_time_dimension) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] alternate_time_dimension Object to be assigned

# File lib/purecloudplatformclientv2/models/journey_aggregation_query.rb, line 301
def alternate_time_dimension=(alternate_time_dimension)
  allowed_values = ["eventTime"]
  if alternate_time_dimension && !allowed_values.include?(alternate_time_dimension)
    fail ArgumentError, "invalid value for 'alternate_time_dimension', must be one of #{allowed_values}."
  end
  @alternate_time_dimension = alternate_time_dimension
end
build_from_hash(attributes) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/journey_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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/journey_aggregation_query.rb, line 330
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/purecloudplatformclientv2/models/journey_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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/purecloudplatformclientv2/models/journey_aggregation_query.rb, line 198
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/journey_aggregation_query.rb, line 403
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/journey_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() click to toggle source
# File lib/purecloudplatformclientv2/models/journey_aggregation_query.rb, line 398
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/purecloudplatformclientv2/models/journey_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