Class: OCI::TenantManagerControlPlane::Models::SubscriptionLineItemSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/tenant_manager_control_plane/models/subscription_line_item_summary.rb

Overview

Summary of line items in a subscription.

Constant Summary collapse

BILLING_MODEL_ENUM = 
[
  BILLING_MODEL_COMMITMENT = 'COMMITMENT'.freeze,
  BILLING_MODEL_PAYGO = 'PAYGO'.freeze,
  BILLING_MODEL_PROMOTION = 'PROMOTION'.freeze,
  BILLING_MODEL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionLineItemSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :product_code (String) —

    The value to assign to the #product_code property

  • :quantity (Float) —

    The value to assign to the #quantity property

  • :billing_model (String) —

    The value to assign to the #billing_model property

  • :time_started (DateTime) —

    The value to assign to the #time_started property

  • :time_ended (DateTime) —

    The value to assign to the #time_ended property

[View source]

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
113
114
115
116
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_line_item_summary.rb', line 83

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 }

  self.id = attributes[:'id'] if attributes[:'id']

  self.product_code = attributes[:'productCode'] if attributes[:'productCode']

  raise 'You cannot provide both :productCode and :product_code' if attributes.key?(:'productCode') && attributes.key?(:'product_code')

  self.product_code = attributes[:'product_code'] if attributes[:'product_code']

  self.quantity = attributes[:'quantity'] if attributes[:'quantity']

  self.billing_model = attributes[:'billingModel'] if attributes[:'billingModel']

  raise 'You cannot provide both :billingModel and :billing_model' if attributes.key?(:'billingModel') && attributes.key?(:'billing_model')

  self.billing_model = attributes[:'billing_model'] if attributes[:'billing_model']

  self.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted']

  raise 'You cannot provide both :timeStarted and :time_started' if attributes.key?(:'timeStarted') && attributes.key?(:'time_started')

  self.time_started = attributes[:'time_started'] if attributes[:'time_started']

  self.time_ended = attributes[:'timeEnded'] if attributes[:'timeEnded']

  raise 'You cannot provide both :timeEnded and :time_ended' if attributes.key?(:'timeEnded') && attributes.key?(:'time_ended')

  self.time_ended = attributes[:'time_ended'] if attributes[:'time_ended']
end

Instance Attribute Details

#billing_model ⇒ String

[Required] Billing model supported by the associated line item.

Returns:

  • (String) 

33
34
35
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_line_item_summary.rb', line 33

def billing_model
  @billing_model
end

#id ⇒ String

[Required] Subscription line item identifier.

Returns:

  • (String) 

21
22
23
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_line_item_summary.rb', line 21

def id
  @id
end

#product_code ⇒ String

[Required] Product code.

Returns:

  • (String) 

25
26
27
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_line_item_summary.rb', line 25

def product_code
  @product_code
end

#quantity ⇒ Float

[Required] Product number.

Returns:

  • (Float) 

29
30
31
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_line_item_summary.rb', line 29

def quantity
  @quantity
end

#time_ended ⇒ DateTime

[Required] The time the subscription item and associated products should end. An RFC 3339 formatted date and time string.

Returns:

  • (DateTime) 

41
42
43
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_line_item_summary.rb', line 41

def time_ended
  @time_ended
end

#time_started ⇒ DateTime

[Required] The time the subscription item and associated products should start. An RFC 3339 formatted date and time string.

Returns:

  • (DateTime) 

37
38
39
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_line_item_summary.rb', line 37

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_line_item_summary.rb', line 44

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'product_code': :'productCode',
    'quantity': :'quantity',
    'billing_model': :'billingModel',
    'time_started': :'timeStarted',
    'time_ended': :'timeEnded'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_line_item_summary.rb', line 58

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'product_code': :'String',
    'quantity': :'Float',
    'billing_model': :'String',
    'time_started': :'DateTime',
    'time_ended': :'DateTime'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared

[View source]

138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_line_item_summary.rb', line 138

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    product_code == other.product_code &&
    quantity == other.quantity &&
    billing_model == other.billing_model &&
    time_started == other.time_started &&
    time_ended == other.time_ended
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

[View source]

173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_line_item_summary.rb', line 173

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
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(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?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method
[View source]

153
154
155
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_line_item_summary.rb', line 153

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

162
163
164
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_line_item_summary.rb', line 162

def hash
  [id, product_code, quantity, billing_model, time_started, time_ended].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

206
207
208
209
210
211
212
213
214
215
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_line_item_summary.rb', line 206

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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

[View source]

200
201
202
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_line_item_summary.rb', line 200

def to_s
  to_hash.to_s
end