class PureCloud::SearchAggregation

Attributes

field[RW]

The field used for aggregation

name[RW]

The name of the aggregation. The response aggregation uses this name.

order[RW]

The order in which aggregation results are sorted

size[RW]

The number aggregations results to return out of the entire result set

type[RW]

The type of aggregation to perform

value[RW]

A value to use for aggregation

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloud/models/search_aggregation.rb, line 40
def self.attribute_map
  {
    
    :'field' => :'field',
    
    :'name' => :'name',
    
    :'type' => :'type',
    
    :'value' => :'value',
    
    :'size' => :'size',
    
    :'order' => :'order'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/search_aggregation.rb, line 71
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[:'field']
    self.field = attributes[:'field']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'type']
    self.type = attributes[:'type']
  end
  
  if attributes[:'value']
    self.value = attributes[:'value']
  end
  
  if attributes[:'size']
    self.size = attributes[:'size']
  end
  
  if attributes[:'order']
    if (value = attributes[:'order']).is_a?(Array)
      self.order = value
    end
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/search_aggregation.rb, line 59
def self.swagger_types
  {
    :'field' => :'String',
    :'name' => :'String',
    :'type' => :'String',
    :'value' => :'String',
    :'size' => :'Integer',
    :'order' => :'Array<String>'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/search_aggregation.rb, line 116
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      field == o.field &&
      name == o.name &&
      type == o.type &&
      value == o.value &&
      size == o.size &&
      order == o.order
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/search_aggregation.rb, line 157
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/search_aggregation.rb, line 217
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/search_aggregation.rb, line 138
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/search_aggregation.rb, line 128
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/search_aggregation.rb, line 133
def hash
  [field, name, type, value, size, order].hash
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

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

return the object in the form of hash

# File lib/purecloud/models/search_aggregation.rb, line 205
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/search_aggregation.rb, line 195
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/search_aggregation.rb, line 107
def type=(type)
  allowed_values = ["COUNT", "SUM", "AVERAGE", "TERM", "CONTAINS", "STARTS_WITH", "ENDS_WITH"]
  if type && !allowed_values.include?(type)
    fail "invalid value for 'type', must be one of #{allowed_values}"
  end
  @type = type
end