Class: OCI::Ocvp::Models::SddcSummary

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

Overview

A summary of the SDDC.

Constant Summary collapse

HCX_MODE_ENUM = 
[
  HCX_MODE_DISABLED = 'DISABLED'.freeze,
  HCX_MODE_ADVANCED = 'ADVANCED'.freeze,
  HCX_MODE_ENTERPRISE = 'ENTERPRISE'.freeze,
  HCX_MODE_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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SddcSummary

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

  • :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

  • :clusters_count (Integer) —

    The value to assign to the #clusters_count property

  • :hcx_fqdn (String) —

    The value to assign to the #hcx_fqdn property

  • :hcx_mode (String) —

    The value to assign to the #hcx_mode property

  • :vcenter_fqdn (String) —

    The value to assign to the #vcenter_fqdn property

  • :nsx_manager_fqdn (String) —

    The value to assign to the #nsx_manager_fqdn 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_single_host_sddc (BOOLEAN) —

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



207
208
209
210
211
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
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 207

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

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

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

  self.hcx_fqdn = attributes[:'hcxFqdn'] if attributes[:'hcxFqdn']

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

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

  self.hcx_mode = attributes[:'hcxMode'] if attributes[:'hcxMode']

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

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

  self.vcenter_fqdn = attributes[:'vcenterFqdn'] if attributes[:'vcenterFqdn']

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

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

  self.nsx_manager_fqdn = attributes[:'nsxManagerFqdn'] if attributes[:'nsxManagerFqdn']

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

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

  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_single_host_sddc = attributes[:'isSingleHostSddc'] unless attributes[:'isSingleHostSddc'].nil?
  self.is_single_host_sddc = false if is_single_host_sddc.nil? && !attributes.key?(:'isSingleHostSddc') # rubocop:disable Style/StringLiterals

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

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

  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

#clusters_count ⇒ Integer

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

Returns:

  • (Integer) 


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

def clusters_count
  @clusters_count
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 64

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


129
130
131
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 129

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 40

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


121
122
123
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 121

def freeform_tags
  @freeform_tags
end

#hcx_fqdn ⇒ String

HCX Fully Qualified Domain Name

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 72

def hcx_fqdn
  @hcx_fqdn
end

#hcx_mode ⇒ String

HCX configuration of the SDDC.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 77

def hcx_mode
  @hcx_mode
end

#id ⇒ String

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

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 33

def id
  @id
end

#is_single_host_sddc ⇒ BOOLEAN

Indicates whether this SDDC is designated for only single ESXi host.

Returns:

  • (BOOLEAN) 


113
114
115
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 113

def is_single_host_sddc
  @is_single_host_sddc
end

#lifecycle_state ⇒ String

The current state of the SDDC.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#nsx_manager_fqdn ⇒ String

FQDN for NSX Manager

Example: nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 91

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


135
136
137
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 135

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


99
100
101
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 99

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


105
106
107
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 105

def time_updated
  @time_updated
end

#vcenter_fqdn ⇒ String

FQDN for vCenter

Example: vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 84

def vcenter_fqdn
  @vcenter_fqdn
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 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.

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

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 58

def vmware_software_version
  @vmware_software_version
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'vmware_software_version': :'vmwareSoftwareVersion',
    'compartment_id': :'compartmentId',
    'clusters_count': :'clustersCount',
    'hcx_fqdn': :'hcxFqdn',
    'hcx_mode': :'hcxMode',
    'vcenter_fqdn': :'vcenterFqdn',
    'nsx_manager_fqdn': :'nsxManagerFqdn',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'is_single_host_sddc': :'isSingleHostSddc',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 162

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'vmware_software_version': :'String',
    'compartment_id': :'String',
    'clusters_count': :'Integer',
    'hcx_fqdn': :'String',
    'hcx_mode': :'String',
    'vcenter_fqdn': :'String',
    'nsx_manager_fqdn': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'is_single_host_sddc': :'BOOLEAN',
    '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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 341

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    vmware_software_version == other.vmware_software_version &&
    compartment_id == other.compartment_id &&
    clusters_count == other.clusters_count &&
    hcx_fqdn == other.hcx_fqdn &&
    hcx_mode == other.hcx_mode &&
    vcenter_fqdn == other.vcenter_fqdn &&
    nsx_manager_fqdn == other.nsx_manager_fqdn &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    is_single_host_sddc == other.is_single_host_sddc &&
    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



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 386

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


366
367
368
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 366

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



375
376
377
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 375

def hash
  [id, display_name, vmware_software_version, compartment_id, clusters_count, hcx_fqdn, hcx_mode, vcenter_fqdn, nsx_manager_fqdn, time_created, time_updated, lifecycle_state, is_single_host_sddc, 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



419
420
421
422
423
424
425
426
427
428
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 419

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



413
414
415
 
# File 'lib/oci/ocvp/models/sddc_summary.rb', line 413

def to_s
  to_hash.to_s
end