Class: OCI::TenantManagerControlPlane::Models::Subscription

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

Overview

Base subscription type, which carries shared properties for any subscription version. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

ClassicSubscription, CloudSubscription

Constant Summary collapse

ENTITY_VERSION_ENUM = 
[
  ENTITY_VERSION_V1 = 'V1'.freeze,
  ENTITY_VERSION_V2 = 'V2'.freeze,
  ENTITY_VERSION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Subscription

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :entity_version (String) —

    The value to assign to the #entity_version property

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :service_name (String) —

    The value to assign to the #service_name property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription.rb', line 119

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.entity_version = attributes[:'entityVersion'] if attributes[:'entityVersion']

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

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.service_name = attributes[:'serviceName'] if attributes[:'serviceName']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The Oracle ID (OCID) of the owning compartment. Always a tenancy OCID.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


55
56
57
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription.rb', line 55

def defined_tags
  @defined_tags
end

#entity_version ⇒ String

[Required] The entity version of the subscription, whether V1 (the legacy schema version), or V2 (the latest 20230401 API version).

Returns:

  • (String) 


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

def entity_version
  @entity_version
end

#freeform_tags ⇒ Hash<String, String>

[Required] Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


49
50
51
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription.rb', line 49

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The Oracle ID (OCID) of the subscription.

Returns:

  • (String) 


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

def id
  @id
end

#service_name ⇒ String

[Required] The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.

Returns:

  • (String) 


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

def service_name
  @service_name
end

#time_created ⇒ DateTime

[Required] The date and time of creation, as described in RFC 3339, section 14.29.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time of update, as described in RFC 3339, section 14.29.

Returns:

  • (DateTime) 


43
44
45
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription.rb', line 43

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription.rb', line 94

def self.get_subtype(object_hash)
  type = object_hash[:'entityVersion'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::TenantManagerControlPlane::Models::ClassicSubscription' if type == 'V1'
  return 'OCI::TenantManagerControlPlane::Models::CloudSubscription' if type == 'V2'

  # TODO: Log a warning when the subtype is not found.
  'OCI::TenantManagerControlPlane::Models::Subscription'
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription.rb', line 74

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>>'
    # 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



190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription.rb', line 190

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription.rb', line 227

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


207
208
209
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription.rb', line 207

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



216
217
218
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription.rb', line 216

def hash
  [entity_version, id, compartment_id, service_name, time_created, time_updated, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



260
261
262
263
264
265
266
267
268
269
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription.rb', line 260

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



254
255
256
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription.rb', line 254

def to_s
  to_hash.to_s
end