Class: WhiteLabelMachineName::SubscriptionMetricUsageReportCreate

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb

Overview

The metric usage is the actual usage of a metric for a particular subscription as collected by an external application.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionMetricUsageReportCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 62

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

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

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

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

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

Instance Attribute Details

#consumed_units ⇒ Object

The consumed units describe the amount of resources consumed. Those consumed units will be billed in the next billing cycle.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 24

def consumed_units
  @consumed_units
end

#description ⇒ Object

The metric usage report description describe the reported usage. This description may be shown to the end user.



27
28
29
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 27

def description
  @description
end

#external_id ⇒ Object

The external id identifies the metric usage uniquely.



30
31
32
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 30

def external_id
  @external_id
end

#metric ⇒ Object

The metric usage report is linked to the metric for which the usage should be recorded.



33
34
35
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 33

def metric
  @metric
end

#subscription ⇒ Object

The subscription to which the usage is added to.



36
37
38
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 36

def subscription
  @subscription
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 39

def self.attribute_map
  {
    :'consumed_units' => :'consumedUnits',
    :'description' => :'description',
    :'external_id' => :'externalId',
    :'metric' => :'metric',
    :'subscription' => :'subscription'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 50

def self.swagger_types
  {
    :'consumed_units' => :'Float',
    :'description' => :'String',
    :'external_id' => :'String',
    :'metric' => :'Integer',
    :'subscription' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



139
140
141
142
143
144
145
146
147
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 139

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      consumed_units == o.consumed_units &&
      description == o.description &&
      external_id == o.external_id &&
      metric == o.metric &&
      subscription == o.subscription
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



185
186
187
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 185

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 =~ /\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
    temp_model = WhiteLabelMachineName.const_get(type).new
    temp_model.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



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 251

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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 164

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


151
152
153
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 151

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



157
158
159
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 157

def hash
  [consumed_units, description, external_id, metric, subscription].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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 91

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

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

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

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

  if @subscription.nil?
    invalid_properties.push('invalid value for "subscription", subscription cannot be nil.')
  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



231
232
233
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 231

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



237
238
239
240
241
242
243
244
245
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 237

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



225
226
227
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 225

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



118
119
120
121
122
123
124
125
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscription_metric_usage_report_create.rb', line 118

def valid?
  return false if @consumed_units.nil?
  return false if !@description.nil? && @description.to_s.length > 100
  return false if @external_id.nil?
  return false if @metric.nil?
  return false if @subscription.nil?
  true
end