class PureCloud::FacetEntry

Attributes

attribute[RW]
missing[RW]
other[RW]
statistics[RW]
term_count[RW]
term_type[RW]
terms[RW]
total[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/facet_entry.rb, line 38
def self.attribute_map
  {
    
    :'attribute' => :'attribute',
    
    :'statistics' => :'statistics',
    
    :'other' => :'other',
    
    :'total' => :'total',
    
    :'missing' => :'missing',
    
    :'term_count' => :'termCount',
    
    :'term_type' => :'termType',
    
    :'terms' => :'terms'
    
  }
end
new(attributes = {}) click to toggle source

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

# File lib/purecloudplatformclientv2/models/facet_entry.rb, line 85
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?(:'attribute')
    
    
    self.attribute = attributes[:'attribute']
    
  
  end

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

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/facet_entry.rb, line 61
def self.swagger_types
  {
    
    :'attribute' => :'TermAttribute',
    
    :'statistics' => :'FacetStatistics',
    
    :'other' => :'Integer',
    
    :'total' => :'Integer',
    
    :'missing' => :'Integer',
    
    :'term_count' => :'Integer',
    
    :'term_type' => :'String',
    
    :'terms' => :'Array<FacetTerm>'
    
  }
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/facet_entry.rb, line 272
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      attribute == o.attribute &&
      statistics == o.statistics &&
      other == o.other &&
      total == o.total &&
      missing == o.missing &&
      term_count == o.term_count &&
      term_type == o.term_type &&
      terms == o.terms
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/facet_entry.rb, line 317
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/facet_entry.rb, line 377
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/purecloudplatformclientv2/models/facet_entry.rb, line 298
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/facet_entry.rb, line 287
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/facet_entry.rb, line 293
def hash
  [attribute, statistics, other, total, missing, term_count, term_type, terms].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/facet_entry.rb, line 170
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
term_type=(term_type) click to toggle source

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

# File lib/purecloudplatformclientv2/models/facet_entry.rb, line 254
def term_type=(term_type)
  allowed_values = ["TERM", "NUMBERRANGE", "NUMBERHISTOGRAM", "DATERANGE", "DATEHISTOGRAM", "ID"]
  if term_type && !allowed_values.include?(term_type)
    fail ArgumentError, "invalid value for 'term_type', must be one of #{allowed_values}."
  end
  @term_type = term_type
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

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

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/facet_entry.rb, line 365
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/facet_entry.rb, line 355
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/facet_entry.rb, line 179
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["TERM", "NUMBERRANGE", "NUMBERHISTOGRAM", "DATERANGE", "DATEHISTOGRAM", "ID"]
  if @term_type && !allowed_values.include?(@term_type)
    return false
  end
  
  
  
  
  
  
  
end