Package com.oracle.bmc.opensearch.model

Class OpensearchCluster.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • displayName

        public OpensearchCluster.Builder displayName​(String displayName)
        The name of the cluster.

        Avoid entering confidential information.

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

      • compartmentId

        public OpensearchCluster.Builder compartmentId​(String compartmentId)
        The OCID of the compartment where the cluster is located.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • timeCreated

        public OpensearchCluster.Builder timeCreated​(Date timeCreated)
        The amount of time in milliseconds since the cluster was created.
        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • timeUpdated

        public OpensearchCluster.Builder timeUpdated​(Date timeUpdated)
        The amount of time in milliseconds since the cluster was updated.
        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder

      • timeDeleted

        public OpensearchCluster.Builder timeDeleted​(Date timeDeleted)
        The amount of time in milliseconds since the cluster was updated.
        Parameters:
        timeDeleted - the value to set
        Returns:
        this builder

      • lifecycleDetails

        public OpensearchCluster.Builder lifecycleDetails​(String lifecycleDetails)
        Additional information about the current lifecycle state of the cluster.
        Parameters:
        lifecycleDetails - the value to set
        Returns:
        this builder

      • freeformTags

        public OpensearchCluster.Builder freeformTags​(Map<String,​String> freeformTags)
        Simple key-value pair that is applied without any predefined name, type or scope.

        Exists for cross-compatibility only. Example: {“bar-key”: “value”}

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

      • definedTags

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

        Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

      • systemTags

        public OpensearchCluster.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-retained”: “true”}}

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

      • softwareVersion

        public OpensearchCluster.Builder softwareVersion​(String softwareVersion)
        The software version the cluster is running.
        Parameters:
        softwareVersion - the value to set
        Returns:
        this builder

      • totalStorageGB

        public OpensearchCluster.Builder totalStorageGB​(Integer totalStorageGB)
        The size in GB of the cluster’s total storage.
        Parameters:
        totalStorageGB - the value to set
        Returns:
        this builder

      • opensearchFqdn

        public OpensearchCluster.Builder opensearchFqdn​(String opensearchFqdn)
        The fully qualified domain name (FQDN) for the cluster’s API endpoint.
        Parameters:
        opensearchFqdn - the value to set
        Returns:
        this builder

      • opensearchPrivateIp

        public OpensearchCluster.Builder opensearchPrivateIp​(String opensearchPrivateIp)
        The cluster’s private IP address.
        Parameters:
        opensearchPrivateIp - the value to set
        Returns:
        this builder

      • opendashboardFqdn

        public OpensearchCluster.Builder opendashboardFqdn​(String opendashboardFqdn)
        The fully qualified domain name (FQDN) for the cluster’s OpenSearch Dashboard API endpoint.
        Parameters:
        opendashboardFqdn - the value to set
        Returns:
        this builder

      • opendashboardPrivateIp

        public OpensearchCluster.Builder opendashboardPrivateIp​(String opendashboardPrivateIp)
        The private IP address for the cluster’s OpenSearch Dashboard.
        Parameters:
        opendashboardPrivateIp - the value to set
        Returns:
        this builder

      • masterNodeCount

        public OpensearchCluster.Builder masterNodeCount​(Integer masterNodeCount)
        The number of master nodes configured for the cluster.
        Parameters:
        masterNodeCount - the value to set
        Returns:
        this builder

      • masterNodeHostType

        public OpensearchCluster.Builder masterNodeHostType​(MasterNodeHostType masterNodeHostType)
        The instance type for the cluster’s master nodes.
        Parameters:
        masterNodeHostType - the value to set
        Returns:
        this builder

      • masterNodeHostBareMetalShape

        public OpensearchCluster.Builder masterNodeHostBareMetalShape​(String masterNodeHostBareMetalShape)
        The bare metal shape for the cluster’s master nodes.
        Parameters:
        masterNodeHostBareMetalShape - the value to set
        Returns:
        this builder

      • masterNodeHostOcpuCount

        public OpensearchCluster.Builder masterNodeHostOcpuCount​(Integer masterNodeHostOcpuCount)
        The number of OCPUs configured for cluster’s master nodes.
        Parameters:
        masterNodeHostOcpuCount - the value to set
        Returns:
        this builder

      • masterNodeHostMemoryGB

        public OpensearchCluster.Builder masterNodeHostMemoryGB​(Integer masterNodeHostMemoryGB)
        The amount of memory in GB, for the cluster’s master nodes.
        Parameters:
        masterNodeHostMemoryGB - the value to set
        Returns:
        this builder

      • dataNodeCount

        public OpensearchCluster.Builder dataNodeCount​(Integer dataNodeCount)
        The number of data nodes configured for the cluster.
        Parameters:
        dataNodeCount - the value to set
        Returns:
        this builder

      • dataNodeHostType

        public OpensearchCluster.Builder dataNodeHostType​(DataNodeHostType dataNodeHostType)
        The instance type for the cluster’s data nodes.
        Parameters:
        dataNodeHostType - the value to set
        Returns:
        this builder

      • dataNodeHostBareMetalShape

        public OpensearchCluster.Builder dataNodeHostBareMetalShape​(String dataNodeHostBareMetalShape)
        The bare metal shape for the cluster’s data nodes.
        Parameters:
        dataNodeHostBareMetalShape - the value to set
        Returns:
        this builder

      • dataNodeHostOcpuCount

        public OpensearchCluster.Builder dataNodeHostOcpuCount​(Integer dataNodeHostOcpuCount)
        The number of OCPUs configured for the cluster’s data nodes.
        Parameters:
        dataNodeHostOcpuCount - the value to set
        Returns:
        this builder

      • dataNodeHostMemoryGB

        public OpensearchCluster.Builder dataNodeHostMemoryGB​(Integer dataNodeHostMemoryGB)
        The amount of memory in GB, for the cluster’s data nodes.
        Parameters:
        dataNodeHostMemoryGB - the value to set
        Returns:
        this builder

      • dataNodeStorageGB

        public OpensearchCluster.Builder dataNodeStorageGB​(Integer dataNodeStorageGB)
        The amount of storage in GB, to configure per node for the cluster’s data nodes.
        Parameters:
        dataNodeStorageGB - the value to set
        Returns:
        this builder

      • opendashboardNodeCount

        public OpensearchCluster.Builder opendashboardNodeCount​(Integer opendashboardNodeCount)
        The number of OpenSearch Dashboard nodes configured for the cluster.
        Parameters:
        opendashboardNodeCount - the value to set
        Returns:
        this builder

      • opendashboardNodeHostOcpuCount

        public OpensearchCluster.Builder opendashboardNodeHostOcpuCount​(Integer opendashboardNodeHostOcpuCount)
        The amount of memory in GB, for the cluster’s OpenSearch Dashboard nodes.
        Parameters:
        opendashboardNodeHostOcpuCount - the value to set
        Returns:
        this builder

      • opendashboardNodeHostMemoryGB

        public OpensearchCluster.Builder opendashboardNodeHostMemoryGB​(Integer opendashboardNodeHostMemoryGB)
        The amount of memory in GB, for the cluster’s OpenSearch Dashboard nodes.
        Parameters:
        opendashboardNodeHostMemoryGB - the value to set
        Returns:
        this builder

      • vcnId

        public OpensearchCluster.Builder vcnId​(String vcnId)
        The OCID of the cluster’s VCN.
        Parameters:
        vcnId - the value to set
        Returns:
        this builder

      • subnetId

        public OpensearchCluster.Builder subnetId​(String subnetId)
        The OCID of the cluster’s subnet.
        Parameters:
        subnetId - the value to set
        Returns:
        this builder

      • vcnCompartmentId

        public OpensearchCluster.Builder vcnCompartmentId​(String vcnCompartmentId)
        The OCID for the compartment where the cluster’s VCN is located.
        Parameters:
        vcnCompartmentId - the value to set
        Returns:
        this builder

      • subnetCompartmentId

        public OpensearchCluster.Builder subnetCompartmentId​(String subnetCompartmentId)
        The OCID for the compartment where the cluster’s subnet is located.
        Parameters:
        subnetCompartmentId - the value to set
        Returns:
        this builder

      • fqdn

        public OpensearchCluster.Builder fqdn​(String fqdn)
        The fully qualified domain name (FQDN) for the cluster’s API endpoint.
        Parameters:
        fqdn - the value to set
        Returns:
        this builder

      • availabilityDomains

        public OpensearchCluster.Builder availabilityDomains​(List<String> availabilityDomains)
        The availability domains to distribute the cluser nodes across.
        Parameters:
        availabilityDomains - the value to set
        Returns:
        this builder

      • securityMode

        public OpensearchCluster.Builder securityMode​(SecurityMode securityMode)
        The security mode of the cluster.
        Parameters:
        securityMode - the value to set
        Returns:
        this builder

      • securityMasterUserName

        public OpensearchCluster.Builder securityMasterUserName​(String securityMasterUserName)
        The name of the master user that are used to manage security config
        Parameters:
        securityMasterUserName - the value to set
        Returns:
        this builder

      • securityMasterUserPasswordHash

        public OpensearchCluster.Builder securityMasterUserPasswordHash​(String securityMasterUserPasswordHash)
        The password hash of the master user that are used to manage security config
        Parameters:
        securityMasterUserPasswordHash - the value to set
        Returns:
        this builder

      • reverseConnectionEndpointCustomerIps

        public OpensearchCluster.Builder reverseConnectionEndpointCustomerIps​(List<String> reverseConnectionEndpointCustomerIps)
        The customer IP addresses of the endpoint in customer VCN
        Parameters:
        reverseConnectionEndpointCustomerIps - the value to set
        Returns:
        this builder

      • reverseConnectionEndpoints

        public OpensearchCluster.Builder reverseConnectionEndpoints​(List<ReverseConnectionEndpoint> reverseConnectionEndpoints)
        The list of reverse connection endpoints.
        Parameters:
        reverseConnectionEndpoints - the value to set
        Returns:
        this builder

      • inboundClusterIds

        public OpensearchCluster.Builder inboundClusterIds​(List<String> inboundClusterIds)
        List of inbound clusters for which this cluster is an outbound cluster
        Parameters:
        inboundClusterIds - the value to set
        Returns:
        this builder