Package com.oracle.bmc.opensearch.model

Class OpensearchCluster

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180828")
public final class OpensearchCluster
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    An OpenSearch cluster resource.

    An OpenSearch cluster is set of instances that provide OpenSearch functionality in OCI Search Service with OpenSearch. For more information, see About Search Service with OpenSearch.
    Note: Objects should always be created or deserialized using the OpensearchCluster.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 OpensearchCluster.Builder, which maintain a set of all explicitly set fields called OpensearchCluster.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

      • OpensearchCluster

        @Deprecated
@ConstructorProperties({"id","displayName","compartmentId","lifecycleState","timeCreated","timeUpdated","timeDeleted","lifecycleDetails","freeformTags","definedTags","systemTags","softwareVersion","totalStorageGB","opensearchFqdn","opensearchPrivateIp","opendashboardFqdn","opendashboardPrivateIp","masterNodeCount","masterNodeHostType","masterNodeHostBareMetalShape","masterNodeHostOcpuCount","masterNodeHostMemoryGB","dataNodeCount","dataNodeHostType","dataNodeHostBareMetalShape","dataNodeHostOcpuCount","dataNodeHostMemoryGB","dataNodeStorageGB","opendashboardNodeCount","opendashboardNodeHostOcpuCount","opendashboardNodeHostMemoryGB","vcnId","subnetId","vcnCompartmentId","subnetCompartmentId","fqdn","availabilityDomains","securityMode","securityMasterUserName","securityMasterUserPasswordHash","securitySamlConfig","backupPolicy","reverseConnectionEndpointCustomerIps","reverseConnectionEndpoints","outboundClusterConfig","inboundClusterIds","maintenanceDetails"})
public OpensearchCluster​(String id,
                         String displayName,
                         String compartmentId,
                         OpensearchCluster.LifecycleState lifecycleState,
                         Date timeCreated,
                         Date timeUpdated,
                         Date timeDeleted,
                         String lifecycleDetails,
                         Map<String,​String> freeformTags,
                         Map<String,​Map<String,​Object>> definedTags,
                         Map<String,​Map<String,​Object>> systemTags,
                         String softwareVersion,
                         Integer totalStorageGB,
                         String opensearchFqdn,
                         String opensearchPrivateIp,
                         String opendashboardFqdn,
                         String opendashboardPrivateIp,
                         Integer masterNodeCount,
                         MasterNodeHostType masterNodeHostType,
                         String masterNodeHostBareMetalShape,
                         Integer masterNodeHostOcpuCount,
                         Integer masterNodeHostMemoryGB,
                         Integer dataNodeCount,
                         DataNodeHostType dataNodeHostType,
                         String dataNodeHostBareMetalShape,
                         Integer dataNodeHostOcpuCount,
                         Integer dataNodeHostMemoryGB,
                         Integer dataNodeStorageGB,
                         Integer opendashboardNodeCount,
                         Integer opendashboardNodeHostOcpuCount,
                         Integer opendashboardNodeHostMemoryGB,
                         String vcnId,
                         String subnetId,
                         String vcnCompartmentId,
                         String subnetCompartmentId,
                         String fqdn,
                         List<String> availabilityDomains,
                         SecurityMode securityMode,
                         String securityMasterUserName,
                         String securityMasterUserPasswordHash,
                         SecuritySamlConfig securitySamlConfig,
                         BackupPolicy backupPolicy,
                         List<String> reverseConnectionEndpointCustomerIps,
                         List<ReverseConnectionEndpoint> reverseConnectionEndpoints,
                         OutboundClusterConfig outboundClusterConfig,
                         List<String> inboundClusterIds,
                         MaintenanceDetails maintenanceDetails)
        Deprecated.

    • Method Detail

      • getId

        public String getId()
        The OCID of the cluster.
        Returns:
        the value

      • 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 where the cluster is located.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The amount of time in milliseconds since the cluster was created.
        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The amount of time in milliseconds since the cluster was updated.
        Returns:
        the value

      • getTimeDeleted

        public Date getTimeDeleted()
        The amount of time in milliseconds since the cluster was updated.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        Additional information about the current lifecycle state of the cluster.
        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

      • getSoftwareVersion

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

      • getTotalStorageGB

        public Integer getTotalStorageGB()
        The size in GB of the cluster’s total storage.
        Returns:
        the value

      • getOpensearchFqdn

        public String getOpensearchFqdn()
        The fully qualified domain name (FQDN) for the cluster’s API endpoint.
        Returns:
        the value

      • getOpensearchPrivateIp

        public String getOpensearchPrivateIp()
        The cluster’s private IP address.
        Returns:
        the value

      • getOpendashboardFqdn

        public String getOpendashboardFqdn()
        The fully qualified domain name (FQDN) for the cluster’s OpenSearch Dashboard API endpoint.
        Returns:
        the value

      • getOpendashboardPrivateIp

        public String getOpendashboardPrivateIp()
        The private IP address for the cluster’s OpenSearch Dashboard.
        Returns:
        the value

      • getMasterNodeCount

        public Integer getMasterNodeCount()
        The number of master nodes configured 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

      • getMasterNodeHostOcpuCount

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

      • getMasterNodeHostMemoryGB

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

      • getDataNodeCount

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

      • getDataNodeHostType

        public DataNodeHostType getDataNodeHostType()
        The 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

      • getDataNodeHostOcpuCount

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

      • getDataNodeHostMemoryGB

        public Integer getDataNodeHostMemoryGB()
        The amount of memory in GB, 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

      • getOpendashboardNodeCount

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

      • getOpendashboardNodeHostOcpuCount

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

      • getOpendashboardNodeHostMemoryGB

        public Integer getOpendashboardNodeHostMemoryGB()
        The amount of memory in GB, for the cluster’s OpenSearch Dashboard 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

      • getFqdn

        public String getFqdn()
        The fully qualified domain name (FQDN) for the cluster’s API endpoint.
        Returns:
        the value

      • getAvailabilityDomains

        public List<String> getAvailabilityDomains()
        The availability domains to distribute the cluser nodes across.
        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

      • getReverseConnectionEndpointCustomerIps

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

      • getReverseConnectionEndpoints

        public List<ReverseConnectionEndpoint> getReverseConnectionEndpoints()
        The list of reverse connection endpoints.
        Returns:
        the value

      • getInboundClusterIds

        public List<String> getInboundClusterIds()
        List of inbound clusters for which this cluster is an outbound cluster
        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