Class: PureCloud::AnalyticsView

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/analytics_view.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyticsView

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/purecloudclient_v2a/models/analytics_view.rb', line 65

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

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

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

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

  
end

Instance Attribute Details

#function ⇒ Object

Type of view you wish to create



28
29
30
 
# File 'lib/purecloudclient_v2a/models/analytics_view.rb', line 28

def function
  @function
end

#name ⇒ Object

A unique name for this view. Must be distinct from other views and built-in metric names.



25
26
27
 
# File 'lib/purecloudclient_v2a/models/analytics_view.rb', line 25

def name
  @name
end

#range ⇒ Object

Range of numbers for slicing up data



31
32
33
 
# File 'lib/purecloudclient_v2a/models/analytics_view.rb', line 31

def range
  @range
end

#target ⇒ Object

CallTarget metric name



22
23
24
 
# File 'lib/purecloudclient_v2a/models/analytics_view.rb', line 22

def target
  @target
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
 
# File 'lib/purecloudclient_v2a/models/analytics_view.rb', line 34

def self.attribute_map
  {
    
    :'target' => :'target',
    
    :'name' => :'name',
    
    :'function' => :'function',
    
    :'range' => :'range'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/purecloudclient_v2a/models/analytics_view.rb', line 49

def self.swagger_types
  {
    
    :'target' => :'String',
    
    :'name' => :'String',
    
    :'function' => :'String',
    
    :'range' => :'AggregationRange'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



193
194
195
196
197
198
199
200
 
# File 'lib/purecloudclient_v2a/models/analytics_view.rb', line 193

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      target == o.target &&
      name == o.name &&
      function == o.function &&
      range == o.range
end

#_deserialize(type, value) ⇒ Object 



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/purecloudclient_v2a/models/analytics_view.rb', line 234

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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/purecloudclient_v2a/models/analytics_view.rb', line 294

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/purecloudclient_v2a/models/analytics_view.rb', line 215

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


204
205
206
 
# File 'lib/purecloudclient_v2a/models/analytics_view.rb', line 204

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



210
211
212
 
# File 'lib/purecloudclient_v2a/models/analytics_view.rb', line 210

def hash
  [target, name, function, range].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



112
113
114
115
116
117
 
# File 'lib/purecloudclient_v2a/models/analytics_view.rb', line 112

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))



277
278
279
 
# File 'lib/purecloudclient_v2a/models/analytics_view.rb', line 277

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



282
283
284
285
286
287
288
289
290
 
# File 'lib/purecloudclient_v2a/models/analytics_view.rb', line 282

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 



272
273
274
 
# File 'lib/purecloudclient_v2a/models/analytics_view.rb', line 272

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



121
122
123
124
125
126
127
128
129
130
131
132
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
 
# File 'lib/purecloudclient_v2a/models/analytics_view.rb', line 121

def valid?
  
  
  if @target.nil?
    return false
  end

  
  
  
  
  
  if @name.nil?
    return false
  end

  
  
  
  
  
  if @function.nil?
    return false
  end

  
  
  allowed_values = ["rangeBound"]
  if @function && !allowed_values.include?(@function)
    return false
  end
  
  
  
  
  
  
  
end