Package com.oracle.bmc.ocvp.model

Class Cluster.Builder

  • Enclosing class:
    Cluster
    public static class Cluster.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public Cluster.Builder id​(String id)
        The OCID of the Cluster.
        Parameters:
        id - the value to set
        Returns:
        this builder

      • computeAvailabilityDomain

        public Cluster.Builder computeAvailabilityDomain​(String computeAvailabilityDomain)
        The availability domain the ESXi hosts are running in.

        For Multi-AD Cluster, it is multi-AD.

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

        Parameters:
        computeAvailabilityDomain - the value to set
        Returns:
        this builder

      • displayName

        public Cluster.Builder displayName​(String displayName)
        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.

        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • instanceDisplayNamePrefix

        public Cluster.Builder instanceDisplayNamePrefix​(String instanceDisplayNamePrefix)
        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.

        Parameters:
        instanceDisplayNamePrefix - the value to set
        Returns:
        this builder

      • vmwareSoftwareVersion

        public Cluster.Builder vmwareSoftwareVersion​(String vmwareSoftwareVersion)
        In general, this is a specific version of bundled VMware software supported by Oracle Cloud VMware Solution (see listSupportedVmwareSoftwareVersions).

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

        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 updateCluster to update the Cluster's vmwareSoftwareVersion with that new version.

        Parameters:
        vmwareSoftwareVersion - the value to set
        Returns:
        this builder

      • esxiSoftwareVersion

        public Cluster.Builder esxiSoftwareVersion​(String esxiSoftwareVersion)
        In general, this is a specific version of bundled ESXi software supported by Oracle Cloud VMware Solution (see listSupportedVmwareSoftwareVersions).

        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 createEsxiHost 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 updateCluster to update the Cluster's esxiSoftwareVersion with that new version.

        Parameters:
        esxiSoftwareVersion - the value to set
        Returns:
        this builder

      • compartmentId

        public Cluster.Builder compartmentId​(String compartmentId)
        The OCID of the compartment that contains the Cluster.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • sddcId

        public Cluster.Builder sddcId​(String sddcId)
        The OCID of the SDDC that the Cluster belongs to.
        Parameters:
        sddcId - the value to set
        Returns:
        this builder

      • esxiHostsCount

        public Cluster.Builder esxiHostsCount​(Integer esxiHostsCount)
        The number of ESXi hosts in the Cluster.
        Parameters:
        esxiHostsCount - the value to set
        Returns:
        this builder

      • initialCommitment

        public Cluster.Builder initialCommitment​(Commitment initialCommitment)
        The billing option selected during Cluster creation.

        listSupportedCommitments.

        Parameters:
        initialCommitment - the value to set
        Returns:
        this builder

      • workloadNetworkCidr

        public Cluster.Builder workloadNetworkCidr​(String workloadNetworkCidr)
        The CIDR block for the IP addresses that VMware VMs in the SDDC use to run application workloads.
        Parameters:
        workloadNetworkCidr - the value to set
        Returns:
        this builder

      • timeCreated

        public Cluster.Builder timeCreated​(Date timeCreated)
        The date and time the Cluster was created, in the format defined by RFC3339.

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

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • timeUpdated

        public Cluster.Builder timeUpdated​(Date timeUpdated)
        The date and time the Cluster was updated, in the format defined by RFC3339.
        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder

      • lifecycleState

        public Cluster.Builder lifecycleState​(LifecycleStates lifecycleState)
        The current state of the Cluster.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder

      • upgradeLicenses

        public Cluster.Builder upgradeLicenses​(List<VsphereLicense> upgradeLicenses)
        The vSphere licenses to use when upgrading the Cluster.
        Parameters:
        upgradeLicenses - the value to set
        Returns:
        this builder

      • vsphereUpgradeObjects

        public Cluster.Builder vsphereUpgradeObjects​(List<VsphereUpgradeObject> vsphereUpgradeObjects)
        The links to binary objects needed to upgrade vSphere.
        Parameters:
        vsphereUpgradeObjects - the value to set
        Returns:
        this builder

      • initialHostShapeName

        public Cluster.Builder initialHostShapeName​(String initialHostShapeName)
        The initial compute shape of the Cluster’s ESXi hosts.

        listSupportedHostShapes.

        Parameters:
        initialHostShapeName - the value to set
        Returns:
        this builder

      • initialHostOcpuCount

        public Cluster.Builder initialHostOcpuCount​(Float initialHostOcpuCount)
        The initial OCPU count of the Cluster’s ESXi hosts.
        Parameters:
        initialHostOcpuCount - the value to set
        Returns:
        this builder

      • isShieldedInstanceEnabled

        public Cluster.Builder isShieldedInstanceEnabled​(Boolean isShieldedInstanceEnabled)
        Indicates whether shielded instance is enabled at the Cluster level.
        Parameters:
        isShieldedInstanceEnabled - the value to set
        Returns:
        this builder

      • capacityReservationId

        public Cluster.Builder capacityReservationId​(String capacityReservationId)
        The OCID of the Capacity Reservation.
        Parameters:
        capacityReservationId - the value to set
        Returns:
        this builder

      • datastores

        public Cluster.Builder datastores​(List<DatastoreDetails> datastores)
        Datastores used for the Cluster.
        Parameters:
        datastores - the value to set
        Returns:
        this builder

      • vsphereType

        public Cluster.Builder vsphereType​(VsphereTypes vsphereType)
        vSphere Cluster types.
        Parameters:
        vsphereType - the value to set
        Returns:
        this builder

      • freeformTags

        public Cluster.Builder freeformTags​(Map<String,​String> freeformTags)
        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"}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder

      • definedTags

        public Cluster.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder

      • systemTags

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

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

        Parameters:
        systemTags - the value to set
        Returns:
        this builder