Class: TogaiClient::UpdateUsageMeterRequest

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

Overview

Request to update usage meter

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateUsageMeterRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



103
104
105
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
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 103

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TogaiClient::UpdateUsageMeterRequest` 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::UpdateUsageMeterRequest`. 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?(:'billable_name')
    self.billable_name = attributes[:'billable_name']
  end

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

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

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  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?(:'filters')
    if (value = attributes[:'filters']).is_a?(Array)
      self.filters = value
    end
  end
end

Instance Attribute Details

#aggregation ⇒ Object

Returns the value of attribute aggregation.



34
35
36
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 34

def aggregation
  @aggregation
end

#billable_name ⇒ Object

Billable name of usage meter. Billable name takes precedence over name to display in invoice.



23
24
25
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 23

def billable_name
  @billable_name
end

#computations ⇒ Object

Returns the value of attribute computations.



36
37
38
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 36

def computations
  @computations
end

#description ⇒ Object

Description of the usage meter



26
27
28
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 26

def description
  @description
end

#event_schema_name ⇒ Object

Event Schema Identifier



29
30
31
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 29

def event_schema_name
  @event_schema_name
end

#filters ⇒ Object

Returns the value of attribute filters.



38
39
40
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 38

def filters
  @filters
end

#name ⇒ Object

Name of usage meter.



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

def name
  @name
end

#type ⇒ Object

Type of usage meter * COUNTER - Count usage



32
33
34
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 32

def type
  @type
end

Class Method Details

._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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 291

def self._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_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



77
78
79
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 77

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'name' => :'name',
    :'billable_name' => :'billableName',
    :'description' => :'description',
    :'event_schema_name' => :'eventSchemaName',
    :'type' => :'type',
    :'aggregation' => :'aggregation',
    :'computations' => :'computations',
    :'filters' => :'filters'
  }
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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 267

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 96

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

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 82

def self.openapi_types
  {
    :'name' => :'String',
    :'billable_name' => :'String',
    :'description' => :'String',
    :'event_schema_name' => :'String',
    :'type' => :'String',
    :'aggregation' => :'UsageMeterAggregation',
    :'computations' => :'Array<Computation>',
    :'filters' => :'Array<UsageMeterFilterEntry>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 239

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      billable_name == o.billable_name &&
      description == o.description &&
      event_schema_name == o.event_schema_name &&
      type == o.type &&
      aggregation == o.aggregation &&
      computations == o.computations &&
      filters == o.filters
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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 362

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


254
255
256
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



260
261
262
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 260

def hash
  [name, billable_name, description, event_schema_name, type, aggregation, computations, filters].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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 155

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 255
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
  end

  if !@billable_name.nil? && @billable_name.to_s.length > 255
    invalid_properties.push('invalid value for "billable_name", the character length must be smaller than or equal to 255.')
  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

  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



338
339
340
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 338

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



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 344

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



332
333
334
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 332

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



175
176
177
178
179
180
181
182
183
 
# File 'lib/togai_client/models/update_usage_meter_request.rb', line 175

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@name.nil? && @name.to_s.length > 255
  return false if !@billable_name.nil? && @billable_name.to_s.length > 255
  return false if !@description.nil? && @description.to_s.length > 255
  type_validator = EnumAttributeValidator.new('String', ["COUNTER"])
  return false unless type_validator.valid?(@type)
  true
end