Class: OCI::Ocvp::Models::Byol

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ocvp/models/byol.rb

Overview

An Oracle Cloud VMware Solution Bring-Your-Own-License (BYOL), is a permit (entitlement) customer purchased from Broadcom and registered in OCI to install VMware software.

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
SOFTWARE_TYPE_ENUM = 
[
  SOFTWARE_TYPE_VCF = 'VCF'.freeze,
  SOFTWARE_TYPE_VSAN = 'VSAN'.freeze,
  SOFTWARE_TYPE_VDEFEND = 'VDEFEND'.freeze,
  SOFTWARE_TYPE_AVI_LOAD_BALANCER = 'AVI_LOAD_BALANCER'.freeze,
  SOFTWARE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Byol

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :software_type (String) —

    The value to assign to the #software_type property

  • :total_units (Integer) —

    The value to assign to the #total_units property

  • :available_units (Integer) —

    The value to assign to the #available_units property

  • :time_term_start (DateTime) —

    The value to assign to the #time_term_start property

  • :time_term_end (DateTime) —

    The value to assign to the #time_term_end property

  • :entitlement_key (String) —

    The value to assign to the #entitlement_key property

  • :site_id (String) —

    The value to assign to the #site_id 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

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

    The value to assign to the #system_tags property



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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/oci/ocvp/models/byol.rb', line 212

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

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

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

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

  self.total_units = attributes[:'totalUnits'] if attributes[:'totalUnits']

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

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

  self.available_units = attributes[:'availableUnits'] if attributes[:'availableUnits']

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

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

  self.time_term_start = attributes[:'timeTermStart'] if attributes[:'timeTermStart']

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

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

  self.time_term_end = attributes[:'timeTermEnd'] if attributes[:'timeTermEnd']

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

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

  self.entitlement_key = attributes[:'entitlementKey'] if attributes[:'entitlementKey']

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

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

  self.site_id = attributes[:'siteId'] if attributes[:'siteId']

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

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#available_units ⇒ Integer

[Required] The quantity of licensed units that not yet allocated to specific region.

Returns:

  • (Integer) 


79
80
81
 
# File 'lib/oci/ocvp/models/byol.rb', line 79

def available_units
  @available_units
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the BYOL.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/ocvp/models/byol.rb', line 42

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. For more information, see Resource Tags.

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

Returns:

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


131
132
133
 
# File 'lib/oci/ocvp/models/byol.rb', line 131

def defined_tags
  @defined_tags
end

#description ⇒ String

A description of the BYOL.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/ocvp/models/byol.rb', line 51

def description
  @description
end

#display_name ⇒ String

[Required] A descriptive name for the BYOL.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/ocvp/models/byol.rb', line 47

def display_name
  @display_name
end

#entitlement_key ⇒ String

[Required] The Broadcom-supplied identifier of a BYOL license.

Returns:

  • (String) 


97
98
99
 
# File 'lib/oci/ocvp/models/byol.rb', line 97

def entitlement_key
  @entitlement_key
end

#freeform_tags ⇒ Hash<String, String>

[Required] 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>) 


123
124
125
 
# File 'lib/oci/ocvp/models/byol.rb', line 123

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the BYOL.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/ocvp/models/byol.rb', line 36

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the BYOL.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/ocvp/models/byol.rb', line 55

def lifecycle_state
  @lifecycle_state
end

#site_id ⇒ String

The hyperscaler identifier in Broadcom systems.

Returns:

  • (String) 


102
103
104
 
# File 'lib/oci/ocvp/models/byol.rb', line 102

def site_id
  @site_id
end

#software_type ⇒ String

[Required] The type of VMware software the BYOL applies to. Supported values: - VCF (VMware Cloud Foundation) - VSAN (VMware vSAN) - VDEFEND (VMware vDefend Firewall) - AVI_LOAD_BALANCER (VMware Avi Load Balancer)

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/ocvp/models/byol.rb', line 65

def software_type
  @software_type
end

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

[Required] Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}

Returns:

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


137
138
139
 
# File 'lib/oci/ocvp/models/byol.rb', line 137

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the BYOL was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


109
110
111
 
# File 'lib/oci/ocvp/models/byol.rb', line 109

def time_created
  @time_created
end

#time_term_end ⇒ DateTime

[Required] The date and time when the BYOL expires and becomes inactive. In the format defined byRFC3339.

Returns:

  • (DateTime) 


92
93
94
 
# File 'lib/oci/ocvp/models/byol.rb', line 92

def time_term_end
  @time_term_end
end

#time_term_start ⇒ DateTime

[Required] The date and time when the BYOL becomes active. VMware software functionality cannot begin before this time. In the format defined byRFC3339. Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


86
87
88
 
# File 'lib/oci/ocvp/models/byol.rb', line 86

def time_term_start
  @time_term_start
end

#time_updated ⇒ DateTime

[Required] The date and time the BYOL was updated, in the format defined by RFC3339.

Returns:

  • (DateTime) 


115
116
117
 
# File 'lib/oci/ocvp/models/byol.rb', line 115

def time_updated
  @time_updated
end

#total_units ⇒ Integer

[Required] Total quantity of licensed units for the specified softwareType:

  • VCF, VDEFEND: number of OCPUs

  • VSAN: storage capacity in TiB (tebibytes)

  • AVI_LOAD_BALANCER: number of instances

Returns:

  • (Integer) 


74
75
76
 
# File 'lib/oci/ocvp/models/byol.rb', line 74

def total_units
  @total_units
end

Class Method Details

.attribute_map ⇒ Object

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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/ocvp/models/byol.rb', line 140

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'lifecycle_state': :'lifecycleState',
    'software_type': :'softwareType',
    'total_units': :'totalUnits',
    'available_units': :'availableUnits',
    'time_term_start': :'timeTermStart',
    'time_term_end': :'timeTermEnd',
    'entitlement_key': :'entitlementKey',
    'site_id': :'siteId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/ocvp/models/byol.rb', line 165

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'lifecycle_state': :'String',
    'software_type': :'String',
    'total_units': :'Integer',
    'available_units': :'Integer',
    'time_term_start': :'DateTime',
    'time_term_end': :'DateTime',
    'entitlement_key': :'String',
    'site_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/oci/ocvp/models/byol.rb', line 346

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    lifecycle_state == other.lifecycle_state &&
    software_type == other.software_type &&
    total_units == other.total_units &&
    available_units == other.available_units &&
    time_term_start == other.time_term_start &&
    time_term_end == other.time_term_end &&
    entitlement_key == other.entitlement_key &&
    site_id == other.site_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/oci/ocvp/models/byol.rb', line 392

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


372
373
374
 
# File 'lib/oci/ocvp/models/byol.rb', line 372

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



381
382
383
 
# File 'lib/oci/ocvp/models/byol.rb', line 381

def hash
  [id, compartment_id, display_name, description, lifecycle_state, software_type, total_units, available_units, time_term_start, time_term_end, entitlement_key, site_id, time_created, time_updated, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



425
426
427
428
429
430
431
432
433
434
 
# File 'lib/oci/ocvp/models/byol.rb', line 425

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



419
420
421
 
# File 'lib/oci/ocvp/models/byol.rb', line 419

def to_s
  to_hash.to_s
end