Class: OCI::TenantManagerControlPlane::Models::ClassicSubscription

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

Overview

Subscription information for the compartmentId. Only root compartments are allowed.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from Subscription

Subscription::ENTITY_VERSION_ENUM

Instance Attribute Summary collapse

Attributes inherited from Subscription

#compartment_id, #defined_tags, #entity_version, #freeform_tags, #id, #service_name, #time_created, #time_updated

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Subscription

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ ClassicSubscription

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 188

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['entityVersion'] = 'V1'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.classic_subscription_id = attributes[:'classicSubscriptionId'] if attributes[:'classicSubscriptionId']

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

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

  self.is_classic_subscription = attributes[:'isClassicSubscription'] unless attributes[:'isClassicSubscription'].nil?
  self.is_classic_subscription = false if is_classic_subscription.nil? && !attributes.key?(:'isClassicSubscription') # rubocop:disable Style/StringLiterals

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

  self.is_classic_subscription = attributes[:'is_classic_subscription'] unless attributes[:'is_classic_subscription'].nil?
  self.is_classic_subscription = false if is_classic_subscription.nil? && !attributes.key?(:'isClassicSubscription') && !attributes.key?(:'is_classic_subscription') # rubocop:disable Style/StringLiterals

  self.payment_model = attributes[:'paymentModel'] if attributes[:'paymentModel']

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

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

  self.region_assignment = attributes[:'regionAssignment'] if attributes[:'regionAssignment']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

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

  self.program_type = attributes[:'programType'] if attributes[:'programType']

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

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

  self.customer_country_code = attributes[:'customerCountryCode'] if attributes[:'customerCountryCode']

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

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

  self.cloud_amount_currency = attributes[:'cloudAmountCurrency'] if attributes[:'cloudAmountCurrency']

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

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

  self.csi_number = attributes[:'csiNumber'] if attributes[:'csiNumber']

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

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

  self.subscription_tier = attributes[:'subscriptionTier'] if attributes[:'subscriptionTier']

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

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

  self.is_government_subscription = attributes[:'isGovernmentSubscription'] unless attributes[:'isGovernmentSubscription'].nil?
  self.is_government_subscription = false if is_government_subscription.nil? && !attributes.key?(:'isGovernmentSubscription') # rubocop:disable Style/StringLiterals

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

  self.is_government_subscription = attributes[:'is_government_subscription'] unless attributes[:'is_government_subscription'].nil?
  self.is_government_subscription = false if is_government_subscription.nil? && !attributes.key?(:'isGovernmentSubscription') && !attributes.key?(:'is_government_subscription') # rubocop:disable Style/StringLiterals

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

  self.purchase_entitlement_id = attributes[:'purchaseEntitlementId'] if attributes[:'purchaseEntitlementId']

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

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

  self.start_date = attributes[:'startDate'] if attributes[:'startDate']

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

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

  self.end_date = attributes[:'endDate'] if attributes[:'endDate']

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

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

  self.region_assignments = attributes[:'regionAssignments'] if attributes[:'regionAssignments']

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

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

Instance Attribute Details

#classic_subscription_id ⇒ String

[Required] Classic subscription ID.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 26

def classic_subscription_id
  @classic_subscription_id
end

#cloud_amount_currency ⇒ String

The currency code for the customer associated with the subscription.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 58

def cloud_amount_currency
  @cloud_amount_currency
end

#csi_number ⇒ String

Customer service identifier for the customer associated with the subscription.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 62

def csi_number
  @csi_number
end

#customer_country_code ⇒ String

The country code for the customer associated with the subscription.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 54

def customer_country_code
  @customer_country_code
end

#end_date ⇒ DateTime

Subscription end time.

Returns:

  • (DateTime) 


86
87
88
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 86

def end_date
  @end_date
end

#is_classic_subscription ⇒ BOOLEAN

Specifies whether or not the subscription is from classic systems.

Returns:

  • (BOOLEAN) 


30
31
32
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 30

def is_classic_subscription
  @is_classic_subscription
end

#is_government_subscription ⇒ BOOLEAN

Specifies whether or not the subscription is a government subscription.

Returns:

  • (BOOLEAN) 


70
71
72
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 70

def is_government_subscription
  @is_government_subscription
end

#lifecycle_state ⇒ String

[Required] Lifecycle state of the subscription.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 42

def lifecycle_state
  @lifecycle_state
end

#payment_model ⇒ String

The pay model of the subscription, such as 'Pay as you go' or 'Monthly'.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 34

def payment_model
  @payment_model
end

#program_type ⇒ String

Specifies any program that is associated with the subscription.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 50

def program_type
  @program_type
end

#promotion ⇒ Array<OCI::TenantManagerControlPlane::Models::Promotion>

List of promotions related to the subscription.

Returns:



74
75
76
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 74

def promotion
  @promotion
end

#purchase_entitlement_id ⇒ String

Purchase entitlement ID associated with the subscription.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 78

def purchase_entitlement_id
  @purchase_entitlement_id
end

#region_assignment ⇒ String

Region for the subscription.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 38

def region_assignment
  @region_assignment
end

#region_assignments ⇒ Array<String>

This list will contain up to 5 regions where the subscription has a physical presence

Returns:

  • (Array<String>) 


90
91
92
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 90

def region_assignments
  @region_assignments
end

#skus ⇒ Array<OCI::TenantManagerControlPlane::Models::SubscriptionSku>

List of SKUs linked to this subscription.

Returns:



46
47
48
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 46

def skus
  @skus
end

#start_date ⇒ DateTime

Subscription start time.

Returns:

  • (DateTime) 


82
83
84
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 82

def start_date
  @start_date
end

#subscription_tier ⇒ String

Tier for the subscription, whether a free promotion subscription or a paid subscription.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 66

def subscription_tier
  @subscription_tier
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 93

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'entity_version': :'entityVersion',
    'id': :'id',
    'compartment_id': :'compartmentId',
    'service_name': :'serviceName',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'classic_subscription_id': :'classicSubscriptionId',
    'is_classic_subscription': :'isClassicSubscription',
    'payment_model': :'paymentModel',
    'region_assignment': :'regionAssignment',
    'lifecycle_state': :'lifecycleState',
    'skus': :'skus',
    'program_type': :'programType',
    'customer_country_code': :'customerCountryCode',
    'cloud_amount_currency': :'cloudAmountCurrency',
    'csi_number': :'csiNumber',
    'subscription_tier': :'subscriptionTier',
    'is_government_subscription': :'isGovernmentSubscription',
    'promotion': :'promotion',
    'purchase_entitlement_id': :'purchaseEntitlementId',
    'start_date': :'startDate',
    'end_date': :'endDate',
    'region_assignments': :'regionAssignments'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 126

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'entity_version': :'String',
    'id': :'String',
    'compartment_id': :'String',
    'service_name': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'classic_subscription_id': :'String',
    'is_classic_subscription': :'BOOLEAN',
    'payment_model': :'String',
    'region_assignment': :'String',
    'lifecycle_state': :'String',
    'skus': :'Array<OCI::TenantManagerControlPlane::Models::SubscriptionSku>',
    'program_type': :'String',
    'customer_country_code': :'String',
    'cloud_amount_currency': :'String',
    'csi_number': :'String',
    'subscription_tier': :'String',
    'is_government_subscription': :'BOOLEAN',
    'promotion': :'Array<OCI::TenantManagerControlPlane::Models::Promotion>',
    'purchase_entitlement_id': :'String',
    'start_date': :'DateTime',
    'end_date': :'DateTime',
    'region_assignments': :'Array<String>'
    # 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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 317

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

  self.class == other.class &&
    entity_version == other.entity_version &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    service_name == other.service_name &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    classic_subscription_id == other.classic_subscription_id &&
    is_classic_subscription == other.is_classic_subscription &&
    payment_model == other.payment_model &&
    region_assignment == other.region_assignment &&
    lifecycle_state == other.lifecycle_state &&
    skus == other.skus &&
    program_type == other.program_type &&
    customer_country_code == other.customer_country_code &&
    cloud_amount_currency == other.cloud_amount_currency &&
    csi_number == other.csi_number &&
    subscription_tier == other.subscription_tier &&
    is_government_subscription == other.is_government_subscription &&
    promotion == other.promotion &&
    purchase_entitlement_id == other.purchase_entitlement_id &&
    start_date == other.start_date &&
    end_date == other.end_date &&
    region_assignments == other.region_assignments
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



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 371

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


351
352
353
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 351

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



360
361
362
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 360

def hash
  [entity_version, id, compartment_id, service_name, time_created, time_updated, freeform_tags, defined_tags, classic_subscription_id, is_classic_subscription, payment_model, region_assignment, lifecycle_state, skus, program_type, customer_country_code, cloud_amount_currency, csi_number, subscription_tier, is_government_subscription, promotion, purchase_entitlement_id, start_date, end_date, region_assignments].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



404
405
406
407
408
409
410
411
412
413
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 404

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



398
399
400
 
# File 'lib/oci/tenant_manager_control_plane/models/classic_subscription.rb', line 398

def to_s
  to_hash.to_s
end