Class: PureCloud::AggregationResult

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/aggregation_result.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AggregationResult

Returns a new instance of AggregationResult.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/purecloud/models/aggregation_result.rb', line 62

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[:'type']
    self.type = attributes[:'type']
  end
  
  if attributes[:'dimension']
    self.dimension = attributes[:'dimension']
  end
  
  if attributes[:'metric']
    self.metric = attributes[:'metric']
  end
  
  if attributes[:'count']
    self.count = attributes[:'count']
  end
  
  if attributes[:'results']
    if (value = attributes[:'results']).is_a?(Array)
      self.results = value
    end
  end
  
end

Instance Attribute Details

#count ⇒ Object

Returns the value of attribute count.



29
30
31
 
# File 'lib/purecloud/models/aggregation_result.rb', line 29

def count
  @count
end

#dimension ⇒ Object

For termFrequency aggregations



24
25
26
 
# File 'lib/purecloud/models/aggregation_result.rb', line 24

def dimension
  @dimension
end

#metric ⇒ Object

For numericRange aggregations



27
28
29
 
# File 'lib/purecloud/models/aggregation_result.rb', line 27

def metric
  @metric
end

#results ⇒ Object

Returns the value of attribute results.



31
32
33
 
# File 'lib/purecloud/models/aggregation_result.rb', line 31

def results
  @results
end

#type ⇒ Object

Returns the value of attribute type.



21
22
23
 
# File 'lib/purecloud/models/aggregation_result.rb', line 21

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/purecloud/models/aggregation_result.rb', line 34

def self.attribute_map
  {
    
    :'type' => :'type',
    
    :'dimension' => :'dimension',
    
    :'metric' => :'metric',
    
    :'count' => :'count',
    
    :'results' => :'results'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/purecloud/models/aggregation_result.rb', line 51

def self.swagger_types
  {
    :'type' => :'String',
    :'dimension' => :'String',
    :'metric' => :'String',
    :'count' => :'Integer',
    :'results' => :'Array<AggregationResultEntry>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



103
104
105
106
107
108
109
110
111
 
# File 'lib/purecloud/models/aggregation_result.rb', line 103

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      dimension == o.dimension &&
      metric == o.metric &&
      count == o.count &&
      results == o.results
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloud/models/aggregation_result.rb', line 143

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



203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/purecloud/models/aggregation_result.rb', line 203

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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/purecloud/models/aggregation_result.rb', line 124

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

Returns:

  • (Boolean)

See Also:

  • `==` method


114
115
116
 
# File 'lib/purecloud/models/aggregation_result.rb', line 114

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



119
120
121
 
# File 'lib/purecloud/models/aggregation_result.rb', line 119

def hash
  [type, dimension, metric, count, results].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



186
187
188
 
# File 'lib/purecloud/models/aggregation_result.rb', line 186

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



191
192
193
194
195
196
197
198
199
 
# File 'lib/purecloud/models/aggregation_result.rb', line 191

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 



181
182
183
 
# File 'lib/purecloud/models/aggregation_result.rb', line 181

def to_s
  to_hash.to_s
end