Package org.opensearch.client.transport.httpclient5.internal

Class Node.Roles

  • Enclosing class:
    Node
    public static final class Node.Roles
extends java.lang.Object
    Role information about an OpenSearch process.

    • Constructor Summary

      Constructors 
      Constructor Description
      Roles​(java.util.Set<java.lang.String> roles)
      Create a Node.Roles instance of the given string set.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)
      Compare two roles for equality
      int hashCode()
      Calculate the hash code of the roles
      boolean isClusterManagerEligible()
      Returns whether or not the node could be elected cluster-manager.
      boolean isData()
      Returns whether or not the node stores data.
      boolean isIngest()
      Returns whether or not the node runs ingest pipelines.
      boolean isMasterEligible()
      Deprecated.
      As of 2.2, because supporting inclusive language, replaced by isClusterManagerEligible()
      boolean isSearch()
      Returns whether the node is dedicated to provide search capability.
      java.lang.String toString()
      Convert roles to string representation

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • Roles

        public Roles​(java.util.Set<java.lang.String> roles)
        Create a Node.Roles instance of the given string set.
        Parameters:
        roles - set of role names.

    • Method Detail

      • isClusterManagerEligible

        public boolean isClusterManagerEligible()
        Returns whether or not the node could be elected cluster-manager.

      • isMasterEligible

        @Deprecated
public boolean isMasterEligible()
        Deprecated.
        As of 2.2, because supporting inclusive language, replaced by isClusterManagerEligible()
        Returns whether or not the node could be elected cluster-manager.

      • isData

        public boolean isData()
        Returns whether or not the node stores data.

      • isIngest

        public boolean isIngest()
        Returns whether or not the node runs ingest pipelines.

      • isSearch

        public boolean isSearch()
        Returns whether the node is dedicated to provide search capability.

      • toString

        public java.lang.String toString()
        Convert roles to string representation
        Overrides:
        toString in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Compare two roles for equality
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - roles instance to compare with

      • hashCode

        public int hashCode()
        Calculate the hash code of the roles
        Overrides:
        hashCode in class java.lang.Object