Class: PureCloud::UserObservationQuery

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserObservationQuery

Initializes the object

Parameters:

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

    Model attributes in the form of hash



58
59
60
61
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
92
93
94
95
96
 
# File 'lib/purecloudplatformclientv2/models/user_observation_query.rb', line 58

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

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

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

  
end

Instance Attribute Details

#detail_metrics ⇒ Object

Metrics for which to include additional detailed observations



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/user_observation_query.rb', line 28

def detail_metrics
  @detail_metrics
end

#filter ⇒ Object

Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/user_observation_query.rb', line 22

def filter
  @filter
end

#metrics ⇒ Object

Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *).



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/user_observation_query.rb', line 25

def metrics
  @metrics
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/purecloudplatformclientv2/models/user_observation_query.rb', line 31

def self.attribute_map
  {
    
    :'filter' => :'filter',
    
    :'metrics' => :'metrics',
    
    :'detail_metrics' => :'detailMetrics'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/purecloudplatformclientv2/models/user_observation_query.rb', line 44

def self.swagger_types
  {
    
    :'filter' => :'UserObservationQueryFilter',
    
    :'metrics' => :'Array<String>',
    
    :'detail_metrics' => :'Array<String>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



148
149
150
151
152
153
154
 
# File 'lib/purecloudplatformclientv2/models/user_observation_query.rb', line 148

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      filter == o.filter &&
      metrics == o.metrics &&
      detail_metrics == o.detail_metrics
end

#_deserialize(type, value) ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/purecloudplatformclientv2/models/user_observation_query.rb', line 188

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



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/purecloudplatformclientv2/models/user_observation_query.rb', line 248

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/purecloudplatformclientv2/models/user_observation_query.rb', line 169

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


158
159
160
 
# File 'lib/purecloudplatformclientv2/models/user_observation_query.rb', line 158

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



164
165
166
 
# File 'lib/purecloudplatformclientv2/models/user_observation_query.rb', line 164

def hash
  [filter, metrics, detail_metrics].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



100
101
102
103
104
105
 
# File 'lib/purecloudplatformclientv2/models/user_observation_query.rb', line 100

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



231
232
233
 
# File 'lib/purecloudplatformclientv2/models/user_observation_query.rb', line 231

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



236
237
238
239
240
241
242
243
244
 
# File 'lib/purecloudplatformclientv2/models/user_observation_query.rb', line 236

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 



226
227
228
 
# File 'lib/purecloudplatformclientv2/models/user_observation_query.rb', line 226

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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/purecloudplatformclientv2/models/user_observation_query.rb', line 109

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

  
  
  
  
  
  
  
  
  
  
  
  
end