Class EsxiHost


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20230701")
    public final class EsxiHost
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    An ESXi host is a node in a Cluster.

    At a minimum, each Cluster has 3 ESXi hosts that are used to implement a functioning VMware environment.

    In terms of implementation, an ESXi host is a Compute instance that is configured with the chosen bundle of VMware software.

    Notice that an EsxiHost object has its own OCID (id), and a separate attribute for the OCID of the Compute instance (computeInstanceId).
    Note: Objects should always be created or deserialized using the EsxiHost.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the EsxiHost.Builder, which maintain a set of all explicitly set fields called EsxiHost.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Constructor Detail

      • EsxiHost

        @Deprecated
        @ConstructorProperties({"id","displayName","sddcId","clusterId","compartmentId","computeInstanceId","timeCreated","timeUpdated","lifecycleState","billingDonorHostId","swapBillingHostId","isBillingContinuationInProgress","isBillingSwappingInProgress","currentCommitment","nextCommitment","billingContractEndDate","failedEsxiHostId","replacementEsxiHostId","gracePeriodEndDate","vmwareSoftwareVersion","esxiSoftwareVersion","nonUpgradedEsxiHostId","upgradedReplacementEsxiHostId","computeAvailabilityDomain","hostShapeName","hostOcpuCount","capacityReservationId","freeformTags","definedTags","systemTags"})
        public EsxiHost​(String id,
                        String displayName,
                        String sddcId,
                        String clusterId,
                        String compartmentId,
                        String computeInstanceId,
                        Date timeCreated,
                        Date timeUpdated,
                        LifecycleStates lifecycleState,
                        String billingDonorHostId,
                        String swapBillingHostId,
                        Boolean isBillingContinuationInProgress,
                        Boolean isBillingSwappingInProgress,
                        Commitment currentCommitment,
                        Commitment nextCommitment,
                        Date billingContractEndDate,
                        String failedEsxiHostId,
                        String replacementEsxiHostId,
                        Date gracePeriodEndDate,
                        String vmwareSoftwareVersion,
                        String esxiSoftwareVersion,
                        String nonUpgradedEsxiHostId,
                        String upgradedReplacementEsxiHostId,
                        String computeAvailabilityDomain,
                        String hostShapeName,
                        Float hostOcpuCount,
                        String capacityReservationId,
                        Map<String,​String> freeformTags,
                        Map<String,​Map<String,​Object>> definedTags,
                        Map<String,​Map<String,​Object>> systemTags)
        Deprecated.
    • Method Detail

      • getId

        public String getId()
        The OCID of the ESXi host.
        Returns:
        the value
      • getDisplayName

        public String getDisplayName()
        A descriptive name for the ESXi host.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Returns:
        the value
      • getSddcId

        public String getSddcId()
        The OCID of the SDDC that the ESXi host belongs to.
        Returns:
        the value
      • getClusterId

        public String getClusterId()
        The OCID of the Cluster that the ESXi host belongs to.
        Returns:
        the value
      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains the Cluster.
        Returns:
        the value
      • getComputeInstanceId

        public String getComputeInstanceId()
        In terms of implementation, an ESXi host is a Compute instance that is configured with the chosen bundle of VMware software.

        The computeInstanceId is the OCID of that Compute instance.

        Returns:
        the value
      • getTimeCreated

        public Date getTimeCreated()
        The date and time the ESXi host was created, in the format defined by RFC3339.

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

        Returns:
        the value
      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time the ESXi host was updated, in the format defined by RFC3339.
        Returns:
        the value
      • getLifecycleState

        public LifecycleStates getLifecycleState()
        The current state of the ESXi host.
        Returns:
        the value
      • getBillingDonorHostId

        public String getBillingDonorHostId()
        The OCID of the deleted ESXi Host with LeftOver billing cycle.
        Returns:
        the value
      • getSwapBillingHostId

        public String getSwapBillingHostId()
        The OCID of the active ESXi Host to swap billing with current host.
        Returns:
        the value
      • getIsBillingContinuationInProgress

        public Boolean getIsBillingContinuationInProgress()
        Indicates whether this host is in the progress of billing continuation.
        Returns:
        the value
      • getIsBillingSwappingInProgress

        public Boolean getIsBillingSwappingInProgress()
        Indicates whether this host is in the progress of swapping billing.
        Returns:
        the value
      • getCurrentCommitment

        public Commitment getCurrentCommitment()
        The billing option currently used by the ESXi host.

        listSupportedCommitments.

        Returns:
        the value
      • getNextCommitment

        public Commitment getNextCommitment()
        The billing option to switch to after the current billing cycle ends.

        If nextCommitment is null or empty, currentCommitment continues to the next billing cycle. listSupportedCommitments.

        Returns:
        the value
      • getBillingContractEndDate

        public Date getBillingContractEndDate()
        Current billing cycle end date.

        If the value in currentCommitment and nextCommitment are different, the value specified in nextCommitment becomes the new currentCommitment when the contractEndDate is reached. Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value
      • getFailedEsxiHostId

        public String getFailedEsxiHostId()
        The OCID of the ESXi host that failed.
        Returns:
        the value
      • getReplacementEsxiHostId

        public String getReplacementEsxiHostId()
        The OCID of the ESXi host that is created to replace the failed host.
        Returns:
        the value
      • getGracePeriodEndDate

        public Date getGracePeriodEndDate()
        The date and time when the new esxi host should start billing cycle.

        RFC3339. Example: 2021-07-25T21:10:29.600Z

        Returns:
        the value
      • getVmwareSoftwareVersion

        public String getVmwareSoftwareVersion()
        The version of VMware software that Oracle Cloud VMware Solution installed on the ESXi hosts.
        Returns:
        the value
      • getEsxiSoftwareVersion

        public String getEsxiSoftwareVersion()
        The version of ESXi software that Oracle Cloud VMware Solution installed on the ESXi hosts.
        Returns:
        the value
      • getNonUpgradedEsxiHostId

        public String getNonUpgradedEsxiHostId()
        The OCID of the ESXi host that will be upgraded.
        Returns:
        the value
      • getUpgradedReplacementEsxiHostId

        public String getUpgradedReplacementEsxiHostId()
        The OCID of the ESXi host that is newly created to upgrade the original host.
        Returns:
        the value
      • getComputeAvailabilityDomain

        public String getComputeAvailabilityDomain()
        The availability domain of the ESXi host.
        Returns:
        the value
      • getHostShapeName

        public String getHostShapeName()
        The compute shape name of the ESXi host.

        listSupportedHostShapes.

        Returns:
        the value
      • getHostOcpuCount

        public Float getHostOcpuCount()
        The OCPU count of the ESXi host.
        Returns:
        the value
      • getCapacityReservationId

        public String getCapacityReservationId()
        The OCID of the Capacity Reservation.
        Returns:
        the value
      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        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:
        the value
      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        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:
        the value
      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        Usage of system tag keys.

        These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}

        Returns:
        the value
      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation
      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel