Class: OCI::Self::Models::CreateSubscriptionDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/self/models/create_subscription_details.rb

Overview

The data to create a Subscription.

Constant Summary collapse

SOURCE_TYPE_ENUM = 
[
  SOURCE_TYPE_OCI_NATIVE = 'OCI_NATIVE'.freeze,
  SOURCE_TYPE_THIRD_PARTY = 'THIRD_PARTY'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSubscriptionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 133

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

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

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

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

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

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

  self.subscription_details = attributes[:'subscriptionDetails'] if attributes[:'subscriptionDetails']

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

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

  self.seller_id = attributes[:'sellerId'] if attributes[:'sellerId']

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

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

  self.source_type = attributes[:'sourceType'] if attributes[:'sourceType']

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

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

  self.product_id = attributes[:'productId'] if attributes[:'productId']

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

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

  self.additional_details = attributes[:'additionalDetails'] if attributes[:'additionalDetails']

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

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

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

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

  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

#additional_details ⇒ Array<OCI::Self::Models::ExtendedMetadata>

Additional details that are specific for this subscription such as activation details.

Returns:



49
50
51
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 49

def additional_details
  @additional_details
end

#compartment_id ⇒ String

[Required] The OCID of the compartment to create the subscription in.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 24

def compartment_id
  @compartment_id
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


73
74
75
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 73

def defined_tags
  @defined_tags
end

#display_name ⇒ String

The subscription name. Must be unique within the compartment. This value can be updated.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 19

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


65
66
67
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 65

def freeform_tags
  @freeform_tags
end

#product_id ⇒ String

[Required] The unique identifier of the marketplace listing in Oracle Cloud Infrastructure.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 45

def product_id
  @product_id
end

#realm ⇒ String

The realm from where customer is buying the subscription.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 53

def realm
  @realm
end

#region ⇒ String

The region from where customer is buying the subscription.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 57

def region
  @region
end

#seller_id ⇒ String

[Required] The OCID for the seller in SELF Service.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 37

def seller_id
  @seller_id
end

#source_type ⇒ String

The type of seller in SELF Service.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 41

def source_type
  @source_type
end

#subscription_details ⇒ OCI::Self::Models::SubscriptionDetails

This attribute is required.

Returns:



33
34
35
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 33

def subscription_details
  @subscription_details
end

#tenant_id ⇒ String

[Required] The OCID of the tenant to create the subscription in.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 29

def tenant_id
  @tenant_id
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 76

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'tenant_id': :'tenantId',
    'subscription_details': :'subscriptionDetails',
    'seller_id': :'sellerId',
    'source_type': :'sourceType',
    'product_id': :'productId',
    'additional_details': :'additionalDetails',
    'realm': :'realm',
    'region': :'region',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 96

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'compartment_id': :'String',
    'tenant_id': :'String',
    'subscription_details': :'OCI::Self::Models::SubscriptionDetails',
    'seller_id': :'String',
    'source_type': :'String',
    'product_id': :'String',
    'additional_details': :'Array<OCI::Self::Models::ExtendedMetadata>',
    'realm': :'String',
    'region': :'String',
    '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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 219

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

  self.class == other.class &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    tenant_id == other.tenant_id &&
    subscription_details == other.subscription_details &&
    seller_id == other.seller_id &&
    source_type == other.source_type &&
    product_id == other.product_id &&
    additional_details == other.additional_details &&
    realm == other.realm &&
    region == other.region &&
    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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 260

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


240
241
242
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 240

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



249
250
251
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 249

def hash
  [display_name, compartment_id, tenant_id, subscription_details, seller_id, source_type, product_id, additional_details, realm, region, 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



293
294
295
296
297
298
299
300
301
302
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 293

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



287
288
289
 
# File 'lib/oci/self/models/create_subscription_details.rb', line 287

def to_s
  to_hash.to_s
end