Class: OCI::Ocvp::Models::Cluster

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

Overview

An Oracle Cloud VMware Solution Cluster contains the resources required for a functional VMware environment. Instances in a Cluster (see EsxiHost) run in a virtual cloud network (VCN) and are preconfigured with VMware and storage. Use the vCenter utility to manage and deploy VMware virtual machines (VMs) in the Cluster.

The Cluster uses a single management subnet for provisioning the Cluster. It also uses a set of VLANs for various components of the VMware environment (vSphere, vMotion, vSAN, and so on). See the Core Services API for information about VCN subnets and VLANs.

Constant Summary collapse

INITIAL_COMMITMENT_ENUM = 
[
  INITIAL_COMMITMENT_HOUR = 'HOUR'.freeze,
  INITIAL_COMMITMENT_MONTH = 'MONTH'.freeze,
  INITIAL_COMMITMENT_ONE_YEAR = 'ONE_YEAR'.freeze,
  INITIAL_COMMITMENT_THREE_YEARS = 'THREE_YEARS'.freeze,
  INITIAL_COMMITMENT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.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
VSPHERE_TYPE_ENUM = 
[
  VSPHERE_TYPE_MANAGEMENT = 'MANAGEMENT'.freeze,
  VSPHERE_TYPE_WORKLOAD = 'WORKLOAD'.freeze,
  VSPHERE_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 = {}) ⇒ Cluster

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/oci/ocvp/models/cluster.rb', line 345

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

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

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

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

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

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

  self.vmware_software_version = attributes[:'vmwareSoftwareVersion'] if attributes[:'vmwareSoftwareVersion']

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

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

  self.esxi_software_version = attributes[:'esxiSoftwareVersion'] if attributes[:'esxiSoftwareVersion']

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

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

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

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

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

  self.esxi_hosts_count = attributes[:'esxiHostsCount'] if attributes[:'esxiHostsCount']

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

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

  self.initial_commitment = attributes[:'initialCommitment'] if attributes[:'initialCommitment']

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

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

  self.workload_network_cidr = attributes[:'workloadNetworkCidr'] if attributes[:'workloadNetworkCidr']

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

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

  self.network_configuration = attributes[:'networkConfiguration'] if attributes[:'networkConfiguration']

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

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

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

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

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

  self.vsphere_upgrade_objects = attributes[:'vsphereUpgradeObjects'] if attributes[:'vsphereUpgradeObjects']

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

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

  self.initial_host_shape_name = attributes[:'initialHostShapeName'] if attributes[:'initialHostShapeName']

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

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

  self.initial_host_ocpu_count = attributes[:'initialHostOcpuCount'] if attributes[:'initialHostOcpuCount']

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

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

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

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

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

  self.capacity_reservation_id = attributes[:'capacityReservationId'] if attributes[:'capacityReservationId']

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

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

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

  self.datastore_cluster_ids = attributes[:'datastoreClusterIds'] if attributes[:'datastoreClusterIds']

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

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

  self.vsphere_type = attributes[:'vsphereType'] if attributes[:'vsphereType']

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

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

  self.cluster_byol_allocation_details = attributes[:'clusterByolAllocationDetails'] if attributes[:'clusterByolAllocationDetails']

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

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

  self.initial_vcf_byol_allocation_id = attributes[:'initialVcfByolAllocationId'] if attributes[:'initialVcfByolAllocationId']

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

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

  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

#capacity_reservation_id ⇒ String

The OCID of the Capacity Reservation.

Returns:

  • (String) 


189
190
191
 
# File 'lib/oci/ocvp/models/cluster.rb', line 189

def capacity_reservation_id
  @capacity_reservation_id
end

#cluster_byol_allocation_details ⇒ OCI::Ocvp::Models::ClusterByolAllocationDetails

Returns:



207
208
209
 
# File 'lib/oci/ocvp/models/cluster.rb', line 207

def cluster_byol_allocation_details
  @cluster_byol_allocation_details
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


114
115
116
 
# File 'lib/oci/ocvp/models/cluster.rb', line 114

def compartment_id
  @compartment_id
end

#compute_availability_domain ⇒ String

[Required] The availability domain the ESXi hosts are running in. For Multi-AD Cluster, it is multi-AD.

Example: Uocm:PHX-AD-1, multi-AD

Returns:

  • (String) 


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

def compute_availability_domain
  @compute_availability_domain
end

#datastore_cluster_ids ⇒ Array<String>

A list of datastore clusters.

Returns:

  • (Array<String>) 


199
200
201
 
# File 'lib/oci/ocvp/models/cluster.rb', line 199

def datastore_cluster_ids
  @datastore_cluster_ids
end

#datastores ⇒ Array<OCI::Ocvp::Models::DatastoreDetails>

Datastores used for the Cluster.

Returns:



194
195
196
 
# File 'lib/oci/ocvp/models/cluster.rb', line 194

def datastores
  @datastores
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>>) 


228
229
230
 
# File 'lib/oci/ocvp/models/cluster.rb', line 228

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A descriptive name for the Cluster. It must be unique, start with a letter, and contain only letters, digits, whitespaces, dashes and underscores. Avoid entering confidential information.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/ocvp/models/cluster.rb', line 62

def display_name
  @display_name
end

#esxi_hosts_count ⇒ Integer

[Required] The number of ESXi hosts in the Cluster.

Returns:

  • (Integer) 


124
125
126
 
# File 'lib/oci/ocvp/models/cluster.rb', line 124

def esxi_hosts_count
  @esxi_hosts_count
end

#esxi_software_version ⇒ String

In general, this is a specific version of bundled ESXi software supported by Oracle Cloud VMware Solution (see list_supported_vmware_software_versions).

This attribute is not guaranteed to reflect the version of software currently installed on the ESXi hosts in the SDDC. The purpose of this attribute is to show the version of software that the Oracle Cloud VMware Solution will install on any new ESXi hosts that you add to this SDDC in the future with create_esxi_host unless a different version is configured on the ESXi host level.

Therefore, if you upgrade the existing ESXi hosts in the Cluster to use a newer version of bundled ESXi software supported by the Oracle Cloud VMware Solution, you should use update_cluster to update the Cluster's esxiSoftwareVersion with that new version.

Returns:

  • (String) 


108
109
110
 
# File 'lib/oci/ocvp/models/cluster.rb', line 108

def esxi_software_version
  @esxi_software_version
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>) 


220
221
222
 
# File 'lib/oci/ocvp/models/cluster.rb', line 220

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Cluster.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/ocvp/models/cluster.rb', line 48

def id
  @id
end

#initial_commitment ⇒ String

The billing option selected during Cluster creation. list_supported_commitments.

Returns:

  • (String) 


130
131
132
 
# File 'lib/oci/ocvp/models/cluster.rb', line 130

def initial_commitment
  @initial_commitment
end

#initial_host_ocpu_count ⇒ Float

The initial OCPU count of the Cluster's ESXi hosts.

Returns:

  • (Float) 


179
180
181
 
# File 'lib/oci/ocvp/models/cluster.rb', line 179

def initial_host_ocpu_count
  @initial_host_ocpu_count
end

#initial_host_shape_name ⇒ String

[Required] The initial compute shape of the Cluster's ESXi hosts. list_supported_host_shapes.

Returns:

  • (String) 


174
175
176
 
# File 'lib/oci/ocvp/models/cluster.rb', line 174

def initial_host_shape_name
  @initial_host_shape_name
end

#initial_vcf_byol_allocation_id ⇒ String

The OCID of the initial VMware BYOL Allocation used to deploy VMware Cloud Foundation.

Returns:

  • (String) 


212
213
214
 
# File 'lib/oci/ocvp/models/cluster.rb', line 212

def initial_vcf_byol_allocation_id
  @initial_vcf_byol_allocation_id
end

#instance_display_name_prefix ⇒ String

A prefix used in the name of each ESXi host and Compute instance in the Cluster. If this isn't set, the Cluster's displayName is used as the prefix.

For example, if the value is MyCluster, the ESXi hosts are named MyCluster-1, MyCluster-2, and so on.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/ocvp/models/cluster.rb', line 71

def instance_display_name_prefix
  @instance_display_name_prefix
end

#is_shielded_instance_enabled ⇒ BOOLEAN

Indicates whether shielded instance is enabled at the Cluster level.

Returns:

  • (BOOLEAN) 


184
185
186
 
# File 'lib/oci/ocvp/models/cluster.rb', line 184

def is_shielded_instance_enabled
  @is_shielded_instance_enabled
end

#lifecycle_state ⇒ String

The current state of the Cluster.

Returns:

  • (String) 


158
159
160
 
# File 'lib/oci/ocvp/models/cluster.rb', line 158

def lifecycle_state
  @lifecycle_state
end

#network_configuration ⇒ OCI::Ocvp::Models::NetworkConfiguration

This attribute is required.

Returns:



140
141
142
 
# File 'lib/oci/ocvp/models/cluster.rb', line 140

def network_configuration
  @network_configuration
end

#sddc_id ⇒ String

[Required] The OCID of the SDDC that the Cluster belongs to.

Returns:

  • (String) 


120
121
122
 
# File 'lib/oci/ocvp/models/cluster.rb', line 120

def sddc_id
  @sddc_id
end

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

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


234
235
236
 
# File 'lib/oci/ocvp/models/cluster.rb', line 234

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


148
149
150
 
# File 'lib/oci/ocvp/models/cluster.rb', line 148

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the Cluster was updated, in the format defined by RFC3339.

Returns:

  • (DateTime) 


154
155
156
 
# File 'lib/oci/ocvp/models/cluster.rb', line 154

def time_updated
  @time_updated
end

#upgrade_licenses ⇒ Array<OCI::Ocvp::Models::VsphereLicense>

The vSphere licenses to use when upgrading the Cluster.

Returns:



163
164
165
 
# File 'lib/oci/ocvp/models/cluster.rb', line 163

def upgrade_licenses
  @upgrade_licenses
end

#vmware_software_version ⇒ String

[Required] In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see list_supported_vmware_software_versions).

This attribute is not guaranteed to reflect the version of software currently installed on the ESXi hosts in the Cluster. The purpose of this attribute is to show the version of software that the Oracle Cloud VMware Solution will install on any new ESXi hosts that you add to this Cluster in the future with create_esxi_host.

Therefore, if you upgrade the existing ESXi hosts in the Cluster to use a newer version of bundled VMware software supported by the Oracle Cloud VMware Solution, you should use update_cluster to update the Cluster's vmwareSoftwareVersion with that new version.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/ocvp/models/cluster.rb', line 89

def vmware_software_version
  @vmware_software_version
end

#vsphere_type ⇒ String

[Required] vSphere Cluster types.

Returns:

  • (String) 


204
205
206
 
# File 'lib/oci/ocvp/models/cluster.rb', line 204

def vsphere_type
  @vsphere_type
end

#vsphere_upgrade_objects ⇒ Array<OCI::Ocvp::Models::VsphereUpgradeObject>

The links to binary objects needed to upgrade vSphere.

Returns:



168
169
170
 
# File 'lib/oci/ocvp/models/cluster.rb', line 168

def vsphere_upgrade_objects
  @vsphere_upgrade_objects
end

#workload_network_cidr ⇒ String

The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application workloads.

Returns:

  • (String) 


136
137
138
 
# File 'lib/oci/ocvp/models/cluster.rb', line 136

def workload_network_cidr
  @workload_network_cidr
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/ocvp/models/cluster.rb', line 237

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compute_availability_domain': :'computeAvailabilityDomain',
    'display_name': :'displayName',
    'instance_display_name_prefix': :'instanceDisplayNamePrefix',
    'vmware_software_version': :'vmwareSoftwareVersion',
    'esxi_software_version': :'esxiSoftwareVersion',
    'compartment_id': :'compartmentId',
    'sddc_id': :'sddcId',
    'esxi_hosts_count': :'esxiHostsCount',
    'initial_commitment': :'initialCommitment',
    'workload_network_cidr': :'workloadNetworkCidr',
    'network_configuration': :'networkConfiguration',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'upgrade_licenses': :'upgradeLicenses',
    'vsphere_upgrade_objects': :'vsphereUpgradeObjects',
    'initial_host_shape_name': :'initialHostShapeName',
    'initial_host_ocpu_count': :'initialHostOcpuCount',
    'is_shielded_instance_enabled': :'isShieldedInstanceEnabled',
    'capacity_reservation_id': :'capacityReservationId',
    'datastores': :'datastores',
    'datastore_cluster_ids': :'datastoreClusterIds',
    'vsphere_type': :'vsphereType',
    'cluster_byol_allocation_details': :'clusterByolAllocationDetails',
    'initial_vcf_byol_allocation_id': :'initialVcfByolAllocationId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/ocvp/models/cluster.rb', line 274

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compute_availability_domain': :'String',
    'display_name': :'String',
    'instance_display_name_prefix': :'String',
    'vmware_software_version': :'String',
    'esxi_software_version': :'String',
    'compartment_id': :'String',
    'sddc_id': :'String',
    'esxi_hosts_count': :'Integer',
    'initial_commitment': :'String',
    'workload_network_cidr': :'String',
    'network_configuration': :'OCI::Ocvp::Models::NetworkConfiguration',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'upgrade_licenses': :'Array<OCI::Ocvp::Models::VsphereLicense>',
    'vsphere_upgrade_objects': :'Array<OCI::Ocvp::Models::VsphereUpgradeObject>',
    'initial_host_shape_name': :'String',
    'initial_host_ocpu_count': :'Float',
    'is_shielded_instance_enabled': :'BOOLEAN',
    'capacity_reservation_id': :'String',
    'datastores': :'Array<OCI::Ocvp::Models::DatastoreDetails>',
    'datastore_cluster_ids': :'Array<String>',
    'vsphere_type': :'String',
    'cluster_byol_allocation_details': :'OCI::Ocvp::Models::ClusterByolAllocationDetails',
    'initial_vcf_byol_allocation_id': :'String',
    '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



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/oci/ocvp/models/cluster.rb', line 566

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

  self.class == other.class &&
    id == other.id &&
    compute_availability_domain == other.compute_availability_domain &&
    display_name == other.display_name &&
    instance_display_name_prefix == other.instance_display_name_prefix &&
    vmware_software_version == other.vmware_software_version &&
    esxi_software_version == other.esxi_software_version &&
    compartment_id == other.compartment_id &&
    sddc_id == other.sddc_id &&
    esxi_hosts_count == other.esxi_hosts_count &&
    initial_commitment == other.initial_commitment &&
    workload_network_cidr == other.workload_network_cidr &&
    network_configuration == other.network_configuration &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    upgrade_licenses == other.upgrade_licenses &&
    vsphere_upgrade_objects == other.vsphere_upgrade_objects &&
    initial_host_shape_name == other.initial_host_shape_name &&
    initial_host_ocpu_count == other.initial_host_ocpu_count &&
    is_shielded_instance_enabled == other.is_shielded_instance_enabled &&
    capacity_reservation_id == other.capacity_reservation_id &&
    datastores == other.datastores &&
    datastore_cluster_ids == other.datastore_cluster_ids &&
    vsphere_type == other.vsphere_type &&
    cluster_byol_allocation_details == other.cluster_byol_allocation_details &&
    initial_vcf_byol_allocation_id == other.initial_vcf_byol_allocation_id &&
    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



624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'lib/oci/ocvp/models/cluster.rb', line 624

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


604
605
606
 
# File 'lib/oci/ocvp/models/cluster.rb', line 604

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



613
614
615
 
# File 'lib/oci/ocvp/models/cluster.rb', line 613

def hash
  [id, compute_availability_domain, display_name, instance_display_name_prefix, vmware_software_version, esxi_software_version, compartment_id, sddc_id, esxi_hosts_count, initial_commitment, workload_network_cidr, network_configuration, time_created, time_updated, lifecycle_state, upgrade_licenses, vsphere_upgrade_objects, initial_host_shape_name, initial_host_ocpu_count, is_shielded_instance_enabled, capacity_reservation_id, datastores, datastore_cluster_ids, vsphere_type, cluster_byol_allocation_details, initial_vcf_byol_allocation_id, 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



657
658
659
660
661
662
663
664
665
666
 
# File 'lib/oci/ocvp/models/cluster.rb', line 657

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



651
652
653
 
# File 'lib/oci/ocvp/models/cluster.rb', line 651

def to_s
  to_hash.to_s
end