Class: PureCloud::AggregationResultEntry

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/aggregation_result_entry.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AggregationResultEntry

Initializes the object



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/purecloudplatformclientv2/models/aggregation_result_entry.rb', line 54

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?(:'count')
    self.count = attributes[:'count']
  end

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

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

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

end

Instance Attribute Details

#count ⇒ Object

Returns the value of attribute count.



21
22
23
 
# File 'lib/purecloudplatformclientv2/models/aggregation_result_entry.rb', line 21

def count
  @count
end

#gte ⇒ Object

For numericRange aggregations



27
28
29
 
# File 'lib/purecloudplatformclientv2/models/aggregation_result_entry.rb', line 27

def gte
  @gte
end

#lt ⇒ Object

For numericRange aggregations



30
31
32
 
# File 'lib/purecloudplatformclientv2/models/aggregation_result_entry.rb', line 30

def lt
  @lt
end

#value ⇒ Object

For termFrequency aggregations



24
25
26
 
# File 'lib/purecloudplatformclientv2/models/aggregation_result_entry.rb', line 24

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
 
# File 'lib/purecloudplatformclientv2/models/aggregation_result_entry.rb', line 33

def self.attribute_map
  {
    :'count' => :'count',
    :'value' => :'value',
    :'gte' => :'gte',
    :'lt' => :'lt'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
 
# File 'lib/purecloudplatformclientv2/models/aggregation_result_entry.rb', line 43

def self.swagger_types
  {
    :'count' => :'Integer',
    :'value' => :'String',
    :'gte' => :'Float',
    :'lt' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



92
93
94
95
96
97
98
99
 
# File 'lib/purecloudplatformclientv2/models/aggregation_result_entry.rb', line 92

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      count == o.count &&
      value == o.value &&
      gte == o.gte &&
      lt == o.lt
end

#_deserialize(type, value) ⇒ Object 



133
134
135
136
137
138
139
140
141
142
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
 
# File 'lib/purecloudplatformclientv2/models/aggregation_result_entry.rb', line 133

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



193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/purecloudplatformclientv2/models/aggregation_result_entry.rb', line 193

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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/purecloudplatformclientv2/models/aggregation_result_entry.rb', line 114

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

See Also:

  • `==` method


103
104
105
 
# File 'lib/purecloudplatformclientv2/models/aggregation_result_entry.rb', line 103

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



109
110
111
 
# File 'lib/purecloudplatformclientv2/models/aggregation_result_entry.rb', line 109

def hash
  [count, value, gte, lt].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



80
81
82
83
 
# File 'lib/purecloudplatformclientv2/models/aggregation_result_entry.rb', line 80

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



176
177
178
 
# File 'lib/purecloudplatformclientv2/models/aggregation_result_entry.rb', line 176

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



181
182
183
184
185
186
187
188
189
 
# File 'lib/purecloudplatformclientv2/models/aggregation_result_entry.rb', line 181

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 



171
172
173
 
# File 'lib/purecloudplatformclientv2/models/aggregation_result_entry.rb', line 171

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



87
88
 
# File 'lib/purecloudplatformclientv2/models/aggregation_result_entry.rb', line 87

def valid?
end