Class: OCI::Ocvp::Models::ClusterSummary

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

Overview

A summary of the Cluster.

Constant Summary collapse

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 = {}) ⇒ ClusterSummary

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

  • :compute_availability_domain (String) —

    The value to assign to the #compute_availability_domain property

  • :sddc_id (String) —

    The value to assign to the #sddc_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :vmware_software_version (String) —

    The value to assign to the #vmware_software_version property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :esxi_hosts_count (Integer) —

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

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :is_shielded_instance_enabled (BOOLEAN) —

    The value to assign to the #is_shielded_instance_enabled property

  • :initial_host_shape_name (String) —

    The value to assign to the #initial_host_shape_name property

  • :initial_host_ocpu_count (Float) —

    The value to assign to the #initial_host_ocpu_count property

  • :vsphere_type (String) —

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



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
312
313
314
315
316
317
318
319
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 214

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

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#compute_availability_domain ⇒ String

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

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 37

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


133
134
135
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 133

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) 


50
51
52
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 50

def display_name
  @display_name
end

#esxi_hosts_count ⇒ Integer

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

Returns:

  • (Integer) 


78
79
80
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 78

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


125
126
127
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 125

def freeform_tags
  @freeform_tags
end

#id ⇒ String

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

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 32

def id
  @id
end

#initial_host_ocpu_count ⇒ Float

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

Returns:

  • (Float) 


112
113
114
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 112

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) 


107
108
109
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 107

def initial_host_shape_name
  @initial_host_shape_name
end

#is_shielded_instance_enabled ⇒ BOOLEAN

Indicates whether shielded instance is enabled at the Cluster level.

Returns:

  • (BOOLEAN) 


101
102
103
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 101

def is_shielded_instance_enabled
  @is_shielded_instance_enabled
end

#lifecycle_state ⇒ String

The current state of the Cluster.

Returns:

  • (String) 


96
97
98
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 96

def lifecycle_state
  @lifecycle_state
end

#sddc_id ⇒ String

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

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 43

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


139
140
141
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 139

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


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

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) 


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

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


68
69
70
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 68

def vmware_software_version
  @vmware_software_version
end

#vsphere_type ⇒ String

[Required] vSphere Cluster types.

Returns:

  • (String) 


117
118
119
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 117

def vsphere_type
  @vsphere_type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compute_availability_domain': :'computeAvailabilityDomain',
    'sddc_id': :'sddcId',
    'display_name': :'displayName',
    'vmware_software_version': :'vmwareSoftwareVersion',
    'compartment_id': :'compartmentId',
    'esxi_hosts_count': :'esxiHostsCount',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'is_shielded_instance_enabled': :'isShieldedInstanceEnabled',
    'initial_host_shape_name': :'initialHostShapeName',
    'initial_host_ocpu_count': :'initialHostOcpuCount',
    'vsphere_type': :'vsphereType',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compute_availability_domain': :'String',
    'sddc_id': :'String',
    'display_name': :'String',
    'vmware_software_version': :'String',
    'compartment_id': :'String',
    'esxi_hosts_count': :'Integer',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'is_shielded_instance_enabled': :'BOOLEAN',
    'initial_host_shape_name': :'String',
    'initial_host_ocpu_count': :'Float',
    'vsphere_type': :'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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 354

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

  self.class == other.class &&
    id == other.id &&
    compute_availability_domain == other.compute_availability_domain &&
    sddc_id == other.sddc_id &&
    display_name == other.display_name &&
    vmware_software_version == other.vmware_software_version &&
    compartment_id == other.compartment_id &&
    esxi_hosts_count == other.esxi_hosts_count &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    is_shielded_instance_enabled == other.is_shielded_instance_enabled &&
    initial_host_shape_name == other.initial_host_shape_name &&
    initial_host_ocpu_count == other.initial_host_ocpu_count &&
    vsphere_type == other.vsphere_type &&
    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



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 400

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


380
381
382
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 380

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



389
390
391
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 389

def hash
  [id, compute_availability_domain, sddc_id, display_name, vmware_software_version, compartment_id, esxi_hosts_count, time_created, time_updated, lifecycle_state, is_shielded_instance_enabled, initial_host_shape_name, initial_host_ocpu_count, vsphere_type, 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



433
434
435
436
437
438
439
440
441
442
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 433

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



427
428
429
 
# File 'lib/oci/ocvp/models/cluster_summary.rb', line 427

def to_s
  to_hash.to_s
end