Class: TogaiClient::UsageMeter

Inherits:
Object
  • Object
show all
Defined in:
lib/togai_client/models/usage_meter.rb

Overview

Structure of usage meter

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UsageMeter

Initializes the object

Parameters:

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

    Model attributes in the form of hash



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
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
 
# File 'lib/togai_client/models/usage_meter.rb', line 106

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TogaiClient::UsageMeter` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TogaiClient::UsageMeter`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'aggregation')
    self.aggregation = attributes[:'aggregation']
  end

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

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'last_activated_at')
    self.last_activated_at = attributes[:'last_activated_at']
  end

  if attributes.key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end
end

Instance Attribute Details

#aggregation ⇒ Object

Aggregation to be applied on usage meter result



31
32
33
 
# File 'lib/togai_client/models/usage_meter.rb', line 31

def aggregation
  @aggregation
end

#computations ⇒ Object

Returns the value of attribute computations.



33
34
35
 
# File 'lib/togai_client/models/usage_meter.rb', line 33

def computations
  @computations
end

#created_at ⇒ Object

Returns the value of attribute created_at.



35
36
37
 
# File 'lib/togai_client/models/usage_meter.rb', line 35

def created_at
  @created_at
end

#description ⇒ Object

Returns the value of attribute description.



22
23
24
 
# File 'lib/togai_client/models/usage_meter.rb', line 22

def description
  @description
end

#last_activated_at ⇒ Object

Returns the value of attribute last_activated_at.



37
38
39
 
# File 'lib/togai_client/models/usage_meter.rb', line 37

def last_activated_at
  @last_activated_at
end

#name ⇒ Object

Name of the usage meter



20
21
22
 
# File 'lib/togai_client/models/usage_meter.rb', line 20

def name
  @name
end

#status ⇒ Object

Status of usage meter



28
29
30
 
# File 'lib/togai_client/models/usage_meter.rb', line 28

def status
  @status
end

#type ⇒ Object

Type of usage meter



25
26
27
 
# File 'lib/togai_client/models/usage_meter.rb', line 25

def type
  @type
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



39
40
41
 
# File 'lib/togai_client/models/usage_meter.rb', line 39

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/togai_client/models/usage_meter.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/togai_client/models/usage_meter.rb', line 64

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'type' => :'type',
    :'status' => :'status',
    :'aggregation' => :'aggregation',
    :'computations' => :'computations',
    :'created_at' => :'createdAt',
    :'last_activated_at' => :'lastActivatedAt',
    :'updated_at' => :'updatedAt'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



322
323
324
 
# File 'lib/togai_client/models/usage_meter.rb', line 322

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
 
# File 'lib/togai_client/models/usage_meter.rb', line 99

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/togai_client/models/usage_meter.rb', line 84

def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'type' => :'String',
    :'status' => :'String',
    :'aggregation' => :'String',
    :'computations' => :'Array<Computation>',
    :'created_at' => :'Time',
    :'last_activated_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/togai_client/models/usage_meter.rb', line 293

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      type == o.type &&
      status == o.status &&
      aggregation == o.aggregation &&
      computations == o.computations &&
      created_at == o.created_at &&
      last_activated_at == o.last_activated_at &&
      updated_at == o.updated_at
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/togai_client/models/usage_meter.rb', line 353

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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 =~ /\A(true|t|yes|y|1)\z/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
    # models (e.g. Pet) or oneOf
    klass = TogaiClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/togai_client/models/usage_meter.rb', line 424

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/togai_client/models/usage_meter.rb', line 329

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


309
310
311
 
# File 'lib/togai_client/models/usage_meter.rb', line 309

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



315
316
317
 
# File 'lib/togai_client/models/usage_meter.rb', line 315

def hash
  [name, description, type, status, aggregation, computations, created_at, last_activated_at, updated_at].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/togai_client/models/usage_meter.rb', line 160

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length > 50
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 50.')
  end

  pattern = Regexp.new(/^[\sa-zA-Z0-9_-]*$/)
  if @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  end

  if !@description.nil? && @description.to_s.length > 255
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 255.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @aggregation.nil?
    invalid_properties.push('invalid value for "aggregation", aggregation cannot be nil.')
  end

  if !@computations.nil? && @computations.length > 1
    invalid_properties.push('invalid value for "computations", number of items must be less than or equal to 1.')
  end

  if !@computations.nil? && @computations.length < 0
    invalid_properties.push('invalid value for "computations", number of items must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



400
401
402
 
# File 'lib/togai_client/models/usage_meter.rb', line 400

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/togai_client/models/usage_meter.rb', line 406

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



394
395
396
 
# File 'lib/togai_client/models/usage_meter.rb', line 394

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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/togai_client/models/usage_meter.rb', line 200

def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 50
  return false if @name !~ Regexp.new(/^[\sa-zA-Z0-9_-]*$/)
  return false if !@description.nil? && @description.to_s.length > 255
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["COUNTER", "GAUGE", "TIMER"])
  return false unless type_validator.valid?(@type)
  status_validator = EnumAttributeValidator.new('String', ["DRAFT", "ACTIVE", "INACTIVE", "ARCHIVED"])
  return false unless status_validator.valid?(@status)
  return false if @aggregation.nil?
  aggregation_validator = EnumAttributeValidator.new('String', ["COUNT", "SUM"])
  return false unless aggregation_validator.valid?(@aggregation)
  return false if !@computations.nil? && @computations.length > 1
  return false if !@computations.nil? && @computations.length < 0
  true
end