Class: PureCloud::ApiUsageQuery

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApiUsageQuery

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
109
110
111
112
 
# File 'lib/purecloudplatformclientv2/models/api_usage_query.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?(:'interval')
    
    
    self.interval = attributes[:'interval']
    
  
  end

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

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

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

  
end

Instance Attribute Details

#granularity ⇒ Object

Date granularity of the results



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

def granularity
  @granularity
end

#group_by ⇒ Object

Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.



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

def group_by
  @group_by
end

#interval ⇒ Object

Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss



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

def interval
  @interval
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 *).



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/api_usage_query.rb', line 31

def metrics
  @metrics
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/purecloudplatformclientv2/models/api_usage_query.rb', line 34

def self.attribute_map
  {
    
    :'interval' => :'interval',
    
    :'granularity' => :'granularity',
    
    :'group_by' => :'groupBy',
    
    :'metrics' => :'metrics'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'interval' => :'String',
    
    :'granularity' => :'String',
    
    :'group_by' => :'Array<String>',
    
    :'metrics' => :'Array<String>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



187
188
189
190
191
192
193
194
 
# File 'lib/purecloudplatformclientv2/models/api_usage_query.rb', line 187

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      interval == o.interval &&
      granularity == o.granularity &&
      group_by == o.group_by &&
      metrics == o.metrics
end

#_deserialize(type, value) ⇒ Object 



228
229
230
231
232
233
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
 
# File 'lib/purecloudplatformclientv2/models/api_usage_query.rb', line 228

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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/purecloudplatformclientv2/models/api_usage_query.rb', line 288

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/purecloudplatformclientv2/models/api_usage_query.rb', line 209

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


198
199
200
 
# File 'lib/purecloudplatformclientv2/models/api_usage_query.rb', line 198

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



204
205
206
 
# File 'lib/purecloudplatformclientv2/models/api_usage_query.rb', line 204

def hash
  [interval, granularity, group_by, 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



116
117
118
119
120
121
 
# File 'lib/purecloudplatformclientv2/models/api_usage_query.rb', line 116

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



271
272
273
 
# File 'lib/purecloudplatformclientv2/models/api_usage_query.rb', line 271

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



276
277
278
279
280
281
282
283
284
 
# File 'lib/purecloudplatformclientv2/models/api_usage_query.rb', line 276

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 



266
267
268
 
# File 'lib/purecloudplatformclientv2/models/api_usage_query.rb', line 266

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



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
 
# File 'lib/purecloudplatformclientv2/models/api_usage_query.rb', line 125

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

  
  
  
  
  
  
  allowed_values = ["Day", "Week", "Month"]
  if @granularity && !allowed_values.include?(@granularity)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
end