Class: PureCloud::AnalyticsView

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AnalyticsView

Returns a new instance of AnalyticsView.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/purecloud/models/analytics_view.rb', line 59

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[:'target']
    self.target = attributes[:'target']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'function']
    self.function = attributes[:'function']
  end
  
  if attributes[:'range']
    self.range = attributes[:'range']
  end
  
end

Instance Attribute Details

#function ⇒ Object

Type of view you wish to create



28
29
30
 
# File 'lib/purecloud/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/purecloud/models/analytics_view.rb', line 25

def name
  @name
end

#range ⇒ Object

Range of numbers for slicing up data



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

def range
  @range
end

#target ⇒ Object

Target metric name



22
23
24
 
# File 'lib/purecloud/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/purecloud/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
 
# File 'lib/purecloud/models/analytics_view.rb', line 49

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

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



94
95
96
97
98
99
100
101
 
# File 'lib/purecloud/models/analytics_view.rb', line 94

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 



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/purecloud/models/analytics_view.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/purecloud/models/analytics_view.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/purecloud/models/analytics_view.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

Returns:

  • (Boolean)

See Also:

  • `==` method


104
105
106
 
# File 'lib/purecloud/models/analytics_view.rb', line 104

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



109
110
111
 
# File 'lib/purecloud/models/analytics_view.rb', line 109

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

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



176
177
178
 
# File 'lib/purecloud/models/analytics_view.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/purecloud/models/analytics_view.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/purecloud/models/analytics_view.rb', line 171

def to_s
  to_hash.to_s
end