Class: OCI::TenantManagerControlPlane::Models::SubscriptionSku

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

Overview

SKU information.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionSku

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :sku (String) —

    The value to assign to the #sku property

  • :quantity (Integer) —

    The value to assign to the #quantity property

  • :description (String) —

    The value to assign to the #description property

  • :gsi_order_line_id (String) —

    The value to assign to the #gsi_order_line_id property

  • :license_part_description (String) —

    The value to assign to the #license_part_description property

  • :metric_name (String) —

    The value to assign to the #metric_name property

  • :is_base_service_component (BOOLEAN) —

    The value to assign to the #is_base_service_component property

  • :is_additional_instance (BOOLEAN) —

    The value to assign to the #is_additional_instance property

  • :start_date (DateTime) —

    The value to assign to the #start_date property

  • :end_date (DateTime) —

    The value to assign to the #end_date property



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

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

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

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

  self.gsi_order_line_id = attributes[:'gsiOrderLineId'] if attributes[:'gsiOrderLineId']

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

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

  self.license_part_description = attributes[:'licensePartDescription'] if attributes[:'licensePartDescription']

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

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

  self.metric_name = attributes[:'metricName'] if attributes[:'metricName']

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

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

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

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

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

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

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

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

  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']
end

Instance Attribute Details

#description ⇒ String

Description of the stock units.

Returns:

  • (String) 


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

def description
  @description
end

#end_date ⇒ DateTime

Date and time when the SKU ended.

Returns:

  • (DateTime) 


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

def end_date
  @end_date
end

#gsi_order_line_id ⇒ String

Sales order line identifier.

Returns:

  • (String) 


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

def gsi_order_line_id
  @gsi_order_line_id
end

#is_additional_instance ⇒ BOOLEAN

Specifies if an additional test instance can be provisioned by the SaaS application.

Returns:

  • (BOOLEAN) 


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

def is_additional_instance
  @is_additional_instance
end

#is_base_service_component ⇒ BOOLEAN

Specifies if the SKU is considered as a parent or child.

Returns:

  • (BOOLEAN) 


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

def is_base_service_component
  @is_base_service_component
end

#license_part_description ⇒ String

Description of the covered product belonging to this SKU.

Returns:

  • (String) 


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

def license_part_description
  @license_part_description
end

#metric_name ⇒ String

Base metric for billing the service.

Returns:

  • (String) 


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

def metric_name
  @metric_name
end

#quantity ⇒ Integer

Quantity of the stock units.

Returns:

  • (Integer) 


17
18
19
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_sku.rb', line 17

def quantity
  @quantity
end

#sku ⇒ String

[Required] Stock Keeping Unit (SKU) ID.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_sku.rb', line 13

def sku
  @sku
end

#start_date ⇒ DateTime

Date and time when the SKU was created.

Returns:

  • (DateTime) 


45
46
47
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_sku.rb', line 45

def start_date
  @start_date
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_sku.rb', line 52

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'sku': :'sku',
    'quantity': :'quantity',
    'description': :'description',
    'gsi_order_line_id': :'gsiOrderLineId',
    'license_part_description': :'licensePartDescription',
    'metric_name': :'metricName',
    'is_base_service_component': :'isBaseServiceComponent',
    'is_additional_instance': :'isAdditionalInstance',
    'start_date': :'startDate',
    'end_date': :'endDate'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_sku.rb', line 70

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'sku': :'String',
    'quantity': :'Integer',
    'description': :'String',
    'gsi_order_line_id': :'String',
    'license_part_description': :'String',
    'metric_name': :'String',
    'is_base_service_component': :'BOOLEAN',
    'is_additional_instance': :'BOOLEAN',
    'start_date': :'DateTime',
    'end_date': :'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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_sku.rb', line 169

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

  self.class == other.class &&
    sku == other.sku &&
    quantity == other.quantity &&
    description == other.description &&
    gsi_order_line_id == other.gsi_order_line_id &&
    license_part_description == other.license_part_description &&
    metric_name == other.metric_name &&
    is_base_service_component == other.is_base_service_component &&
    is_additional_instance == other.is_additional_instance &&
    start_date == other.start_date &&
    end_date == other.end_date
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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_sku.rb', line 208

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


188
189
190
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_sku.rb', line 188

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



197
198
199
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_sku.rb', line 197

def hash
  [sku, quantity, description, gsi_order_line_id, license_part_description, metric_name, is_base_service_component, is_additional_instance, start_date, end_date].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



241
242
243
244
245
246
247
248
249
250
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_sku.rb', line 241

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



235
236
237
 
# File 'lib/oci/tenant_manager_control_plane/models/subscription_sku.rb', line 235

def to_s
  to_hash.to_s
end