class OCI::Ocvp::Models::SddcSummary
A summary of the SDDC.
Constants
- LIFECYCLE_STATE_ENUM
Attributes
[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that contains the SDDC.
@return [String]
[Required] The availability domain that the SDDC's ESXi hosts are running in.
@return [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.
@return [String]
[Required] The number of ESXi hosts in the SDDC. @return [Integer]
HCX Fully Qualified Domain Name @return [String]
[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment that contains the SDDC.
@return [String]
HCX enabled or not @return [BOOLEAN]
The current state of the SDDC. @return [String]
FQDN for NSX Manager
Example: `nsx-my-sddc.sddc.us-phoenix-1.oraclecloud.com`
@return [String]
The date and time the SDDC was created, in the format defined by [RFC3339](tools.ietf.org/html/rfc3339).
Example: `2016-08-25T21:10:29.600Z`
@return [DateTime]
The date and time the SDDC was updated, in the format defined by [RFC3339](tools.ietf.org/html/rfc3339).
@return [DateTime]
FQDN for vCenter
Example: `vcenter-my-sddc.sddc.us-phoenix-1.oraclecloud.com`
@return [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 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 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 update_sddc} to update the SDDC's `vmwareSoftwareVersion` with that new version.
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/ocvp/models/sddc_summary.rb, line 124 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'compute_availability_domain': :'computeAvailabilityDomain', 'display_name': :'displayName', 'vmware_software_version': :'vmwareSoftwareVersion', 'compartment_id': :'compartmentId', 'esxi_hosts_count': :'esxiHostsCount', 'hcx_fqdn': :'hcxFqdn', 'is_hcx_enabled': :'isHcxEnabled', 'vcenter_fqdn': :'vcenterFqdn', 'nsx_manager_fqdn': :'nsxManagerFqdn', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'lifecycle_state': :'lifecycleState', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :compute_availability_domain The value to assign to the {#compute_availability_domain} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :vmware_software_version The value to assign to the {#vmware_software_version} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [Integer] :esxi_hosts_count The value to assign to the {#esxi_hosts_count} property @option attributes [String] :hcx_fqdn The value to assign to the {#hcx_fqdn} property @option attributes [BOOLEAN] :is_hcx_enabled The value to assign to the {#is_hcx_enabled} property @option attributes [String] :vcenter_fqdn The value to assign to the {#vcenter_fqdn} property @option attributes [String] :nsx_manager_fqdn The value to assign to the {#nsx_manager_fqdn} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [DateTime] :time_updated The value to assign to the {#time_updated} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property
# File lib/oci/ocvp/models/sddc_summary.rb, line 190 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.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.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.is_hcx_enabled = attributes[:'isHcxEnabled'] unless attributes[:'isHcxEnabled'].nil? raise 'You cannot provide both :isHcxEnabled and :is_hcx_enabled' if attributes.key?(:'isHcxEnabled') && attributes.key?(:'is_hcx_enabled') self.is_hcx_enabled = attributes[:'is_hcx_enabled'] unless attributes[:'is_hcx_enabled'].nil? 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.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'] end
Attribute type mapping.
# File lib/oci/ocvp/models/sddc_summary.rb, line 147 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'compute_availability_domain': :'String', 'display_name': :'String', 'vmware_software_version': :'String', 'compartment_id': :'String', 'esxi_hosts_count': :'Integer', 'hcx_fqdn': :'String', 'is_hcx_enabled': :'BOOLEAN', 'vcenter_fqdn': :'String', 'nsx_manager_fqdn': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'lifecycle_state': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/ocvp/models/sddc_summary.rb, line 303 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 && vmware_software_version == other.vmware_software_version && compartment_id == other.compartment_id && esxi_hosts_count == other.esxi_hosts_count && hcx_fqdn == other.hcx_fqdn && is_hcx_enabled == other.is_hcx_enabled && 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 && freeform_tags == other.freeform_tags && defined_tags == other.defined_tags end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/ocvp/models/sddc_summary.rb, line 347 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/ocvp/models/sddc_summary.rb, line 327 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/ocvp/models/sddc_summary.rb, line 336 def hash [id, compute_availability_domain, display_name, vmware_software_version, compartment_id, esxi_hosts_count, hcx_fqdn, is_hcx_enabled, vcenter_fqdn, nsx_manager_fqdn, time_created, time_updated, lifecycle_state, freeform_tags, defined_tags].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/ocvp/models/sddc_summary.rb, line 287 def lifecycle_state=(lifecycle_state) # rubocop:disable Style/ConditionalAssignment if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state) OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE else @lifecycle_state = lifecycle_state end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/ocvp/models/sddc_summary.rb, line 380 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/ocvp/models/sddc_summary.rb, line 374 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/ocvp/models/sddc_summary.rb, line 397 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end