Class: Fastly::Usagemetric

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/models/usagemetric.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Usagemetric

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/fastly/models/usagemetric.rb', line 86

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#last_updated_at ⇒ Object

The date when the usage metric was last updated.



41
42
43
 
# File 'lib/fastly/models/usagemetric.rb', line 41

def last_updated_at
  @last_updated_at
end

#month ⇒ Object

The year and month of the usage element.



17
18
19
 
# File 'lib/fastly/models/usagemetric.rb', line 17

def month
  @month
end

#name ⇒ Object

Full name of the product usage type as it might appear on a customer’s invoice.



23
24
25
 
# File 'lib/fastly/models/usagemetric.rb', line 23

def name
  @name
end

#product_id ⇒ Object

The product identifier associated with the usage type. This corresponds to a Fastly product offering.



38
39
40
 
# File 'lib/fastly/models/usagemetric.rb', line 38

def product_id
  @product_id
end

#quantity ⇒ Object

The quantity of the usage for the product.



32
33
34
 
# File 'lib/fastly/models/usagemetric.rb', line 32

def quantity
  @quantity
end

#raw_quantity ⇒ Object

The raw units measured for the product.



35
36
37
 
# File 'lib/fastly/models/usagemetric.rb', line 35

def raw_quantity
  @raw_quantity
end

#region ⇒ Object

The geographical area applicable for regionally based products.



26
27
28
 
# File 'lib/fastly/models/usagemetric.rb', line 26

def region
  @region
end

#unit ⇒ Object

The unit for the usage as shown on an invoice. If there is no explicit unit, this field will be "unit" (e.g., a request with ‘product_id` of ’cdn_usage’ and ‘usage_type` of ’North America Requests’ has no unit, and will return "unit").



29
30
31
 
# File 'lib/fastly/models/usagemetric.rb', line 29

def unit
  @unit
end

#usage_type ⇒ Object

The usage type identifier for the usage. This is a single, billable metric for the product.



20
21
22
 
# File 'lib/fastly/models/usagemetric.rb', line 20

def usage_type
  @usage_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



59
60
61
 
# File 'lib/fastly/models/usagemetric.rb', line 59

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/fastly/models/usagemetric.rb', line 44

def self.attribute_map
  {
    :'month' => :'month',
    :'usage_type' => :'usage_type',
    :'name' => :'name',
    :'region' => :'region',
    :'unit' => :'unit',
    :'quantity' => :'quantity',
    :'raw_quantity' => :'raw_quantity',
    :'product_id' => :'product_id',
    :'last_updated_at' => :'last_updated_at'
  }
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



180
181
182
 
# File 'lib/fastly/models/usagemetric.rb', line 180

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

.fastly_nullable ⇒ Object

List of attributes with nullable: true



79
80
81
82
 
# File 'lib/fastly/models/usagemetric.rb', line 79

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

.fastly_types ⇒ Object

Attribute type mapping.



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

def self.fastly_types
  {
    :'month' => :'String',
    :'usage_type' => :'String',
    :'name' => :'String',
    :'region' => :'String',
    :'unit' => :'String',
    :'quantity' => :'Float',
    :'raw_quantity' => :'Float',
    :'product_id' => :'String',
    :'last_updated_at' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/fastly/models/usagemetric.rb', line 151

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      month == o.month &&
      usage_type == o.usage_type &&
      name == o.name &&
      region == o.region &&
      unit == o.unit &&
      quantity == o.quantity &&
      raw_quantity == o.raw_quantity &&
      product_id == o.product_id &&
      last_updated_at == o.last_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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/fastly/models/usagemetric.rb', line 210

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 = Fastly.const_get(type)
    klass.respond_to?(:fastly_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



281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/fastly/models/usagemetric.rb', line 281

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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/fastly/models/usagemetric.rb', line 187

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.fastly_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.fastly_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


167
168
169
 
# File 'lib/fastly/models/usagemetric.rb', line 167

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



173
174
175
 
# File 'lib/fastly/models/usagemetric.rb', line 173

def hash
  [month, usage_type, name, region, unit, quantity, raw_quantity, product_id, last_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



138
139
140
141
 
# File 'lib/fastly/models/usagemetric.rb', line 138

def list_invalid_properties
  invalid_properties = Array.new
  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



257
258
259
 
# File 'lib/fastly/models/usagemetric.rb', line 257

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



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/fastly/models/usagemetric.rb', line 263

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.fastly_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



251
252
253
 
# File 'lib/fastly/models/usagemetric.rb', line 251

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



145
146
147
 
# File 'lib/fastly/models/usagemetric.rb', line 145

def valid?
  true
end