Package com.oracle.bmc.opensearch.model

Class CreateOpensearchClusterDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180828")
public final class CreateOpensearchClusterDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The configuration details for a new OpenSearch cluster.
    Note: Objects should always be created or deserialized using the CreateOpensearchClusterDetails.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 CreateOpensearchClusterDetails.Builder, which maintain a set of all explicitly set fields called CreateOpensearchClusterDetails.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

      • CreateOpensearchClusterDetails

        @Deprecated
@ConstructorProperties({"displayName","compartmentId","softwareVersion","masterNodeCount","masterNodeHostType","masterNodeHostBareMetalShape","masterNodeHostShape","masterNodeHostOcpuCount","masterNodeHostMemoryGB","dataNodeCount","dataNodeHostType","dataNodeHostBareMetalShape","dataNodeHostShape","dataNodeHostOcpuCount","dataNodeHostMemoryGB","dataNodeStorageGB","opendashboardNodeHostShape","opendashboardNodeCount","opendashboardNodeHostOcpuCount","opendashboardNodeHostMemoryGB","searchNodeCount","searchNodeHostType","searchNodeHostShape","searchNodeHostOcpuCount","searchNodeHostMemoryGB","searchNodeStorageGB","vcnId","subnetId","vcnCompartmentId","subnetCompartmentId","securityMode","securityMasterUserName","securityMasterUserPasswordHash","securitySamlConfig","backupPolicy","nsgId","reverseConnectionEndpointCustomerIps","inboundClusterIds","outboundClusterConfig","maintenanceDetails","certificateConfig","freeformTags","definedTags","systemTags","securityAttributes"})
public CreateOpensearchClusterDetails​(String displayName,
                                      String compartmentId,
                                      String softwareVersion,
                                      Integer masterNodeCount,
                                      MasterNodeHostType masterNodeHostType,
                                      String masterNodeHostBareMetalShape,
                                      String masterNodeHostShape,
                                      Integer masterNodeHostOcpuCount,
                                      Integer masterNodeHostMemoryGB,
                                      Integer dataNodeCount,
                                      DataNodeHostType dataNodeHostType,
                                      String dataNodeHostBareMetalShape,
                                      String dataNodeHostShape,
                                      Integer dataNodeHostOcpuCount,
                                      Integer dataNodeHostMemoryGB,
                                      Integer dataNodeStorageGB,
                                      String opendashboardNodeHostShape,
                                      Integer opendashboardNodeCount,
                                      Integer opendashboardNodeHostOcpuCount,
                                      Integer opendashboardNodeHostMemoryGB,
                                      Integer searchNodeCount,
                                      SearchNodeHostType searchNodeHostType,
                                      String searchNodeHostShape,
                                      Integer searchNodeHostOcpuCount,
                                      Integer searchNodeHostMemoryGB,
                                      Integer searchNodeStorageGB,
                                      String vcnId,
                                      String subnetId,
                                      String vcnCompartmentId,
                                      String subnetCompartmentId,
                                      SecurityMode securityMode,
                                      String securityMasterUserName,
                                      String securityMasterUserPasswordHash,
                                      SecuritySamlConfig securitySamlConfig,
                                      BackupPolicy backupPolicy,
                                      String nsgId,
                                      List<String> reverseConnectionEndpointCustomerIps,
                                      List<String> inboundClusterIds,
                                      OutboundClusterConfig outboundClusterConfig,
                                      CreateMaintenanceDetails maintenanceDetails,
                                      CertificateConfig certificateConfig,
                                      Map<String,​String> freeformTags,
                                      Map<String,​Map<String,​Object>> definedTags,
                                      Map<String,​Map<String,​Object>> systemTags,
                                      Map<String,​Map<String,​Object>> securityAttributes)
        Deprecated.

    • Method Detail

      • getDisplayName

        public String getDisplayName()
        The name of the cluster.

        Avoid entering confidential information.

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment to create the cluster in.
        Returns:
        the value

      • getSoftwareVersion

        public String getSoftwareVersion()
        The version of the software the cluster is running.
        Returns:
        the value

      • getMasterNodeCount

        public Integer getMasterNodeCount()
        The number of master nodes to configure for the cluster.
        Returns:
        the value

      • getMasterNodeHostType

        public MasterNodeHostType getMasterNodeHostType()
        The instance type for the cluster’s master nodes.
        Returns:
        the value

      • getMasterNodeHostBareMetalShape

        public String getMasterNodeHostBareMetalShape()
        The bare metal shape for the cluster’s master nodes.
        Returns:
        the value

      • getMasterNodeHostShape

        public String getMasterNodeHostShape()
        The node shape for the cluster’s master nodes.
        Returns:
        the value

      • getMasterNodeHostOcpuCount

        public Integer getMasterNodeHostOcpuCount()
        The number of OCPUs to configure for the cluser’s master nodes.
        Returns:
        the value

      • getMasterNodeHostMemoryGB

        public Integer getMasterNodeHostMemoryGB()
        The amount of memory in GB, to configure per node for the cluster’s master nodes.
        Returns:
        the value

      • getDataNodeCount

        public Integer getDataNodeCount()
        The number of data nodes to configure for the cluster.
        Returns:
        the value

      • getDataNodeHostType

        public DataNodeHostType getDataNodeHostType()
        TThe instance type for the cluster’s data nodes.
        Returns:
        the value

      • getDataNodeHostBareMetalShape

        public String getDataNodeHostBareMetalShape()
        The bare metal shape for the cluster’s data nodes.
        Returns:
        the value

      • getDataNodeHostShape

        public String getDataNodeHostShape()
        The node shape for the cluster’s data nodes.
        Returns:
        the value

      • getDataNodeHostOcpuCount

        public Integer getDataNodeHostOcpuCount()
        The number of OCPUs to configure for the cluster’s data nodes.
        Returns:
        the value

      • getDataNodeHostMemoryGB

        public Integer getDataNodeHostMemoryGB()
        The amount of memory in GB, to configure per node for the cluster’s data nodes.
        Returns:
        the value

      • getDataNodeStorageGB

        public Integer getDataNodeStorageGB()
        The amount of storage in GB, to configure per node for the cluster’s data nodes.
        Returns:
        the value

      • getOpendashboardNodeHostShape

        public String getOpendashboardNodeHostShape()
        The node shape for the cluster’s OpenSearch Dashboard nodes.
        Returns:
        the value

      • getOpendashboardNodeCount

        public Integer getOpendashboardNodeCount()
        The number of OpenSearch Dashboard nodes to configure for the cluster.
        Returns:
        the value

      • getOpendashboardNodeHostOcpuCount

        public Integer getOpendashboardNodeHostOcpuCount()
        The number of OCPUs to configure for the cluster’s OpenSearch Dashboard nodes.
        Returns:
        the value

      • getOpendashboardNodeHostMemoryGB

        public Integer getOpendashboardNodeHostMemoryGB()
        The amount of memory in GB, to configure for the cluster’s OpenSearch Dashboard nodes.
        Returns:
        the value

      • getSearchNodeCount

        public Integer getSearchNodeCount()
        The number of search nodes configured for the cluster.
        Returns:
        the value

      • getSearchNodeHostType

        public SearchNodeHostType getSearchNodeHostType()
        The instance type for the cluster’s search nodes.
        Returns:
        the value

      • getSearchNodeHostShape

        public String getSearchNodeHostShape()
        The node shape for the cluster’s search nodes.
        Returns:
        the value

      • getSearchNodeHostOcpuCount

        public Integer getSearchNodeHostOcpuCount()
        The number of OCPUs configured for the cluster’s search nodes.
        Returns:
        the value

      • getSearchNodeHostMemoryGB

        public Integer getSearchNodeHostMemoryGB()
        The amount of memory in GB, for the cluster’s search nodes.
        Returns:
        the value

      • getSearchNodeStorageGB

        public Integer getSearchNodeStorageGB()
        The amount of storage in GB, to configure per node for the cluster’s search nodes.
        Returns:
        the value

      • getVcnId

        public String getVcnId()
        The OCID of the cluster’s VCN.
        Returns:
        the value

      • getSubnetId

        public String getSubnetId()
        The OCID of the cluster’s subnet.
        Returns:
        the value

      • getVcnCompartmentId

        public String getVcnCompartmentId()
        The OCID for the compartment where the cluster’s VCN is located.
        Returns:
        the value

      • getSubnetCompartmentId

        public String getSubnetCompartmentId()
        The OCID for the compartment where the cluster’s subnet is located.
        Returns:
        the value

      • getSecurityMode

        public SecurityMode getSecurityMode()
        The security mode of the cluster.
        Returns:
        the value

      • getSecurityMasterUserName

        public String getSecurityMasterUserName()
        The name of the master user that are used to manage security config
        Returns:
        the value

      • getSecurityMasterUserPasswordHash

        public String getSecurityMasterUserPasswordHash()
        The password hash of the master user that are used to manage security config
        Returns:
        the value

      • getNsgId

        public String getNsgId()
        The OCID of the NSG where the private endpoint vnic will be attached.
        Returns:
        the value

      • getReverseConnectionEndpointCustomerIps

        public List<String> getReverseConnectionEndpointCustomerIps()
        The customer IP addresses of the endpoint in customer VCN
        Returns:
        the value

      • getInboundClusterIds

        public List<String> getInboundClusterIds()
        List of inbound clusters that will be queried using cross cluster search
        Returns:
        the value

      • getFreeformTags

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

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

        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. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

        Returns:
        the value

      • getSecurityAttributes

        public Map<String,​Map<String,​Object>> getSecurityAttributes()
        Security attributes for this resource.

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

        Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}

        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