Class Node.Roles

java.lang.Object
org.opensearch.client.Node.Roles
Enclosing class:
Node

public static final class Node.Roles extends Object
Role information about an OpenSearch process.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Roles(Set<String> roles)
    Create a Node.Roles instance of the given string set.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Compare two roles for equality
    int
    Calculate the hash code of the roles
    boolean
    Returns whether or not the node could be elected cluster-manager.
    boolean
    Returns whether or not the node stores data.
    boolean
    Returns whether or not the node runs ingest pipelines.
    boolean
    Returns whether the node is dedicated to provide search capability.
    Convert roles to string representation

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • Roles

      public Roles(Set<String> roles)
      Create a Node.Roles instance of the given string set.
      Parameters:
      roles - set of role names.
  • Method Details

    • isClusterManagerEligible

      public boolean 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 String toString()
      Convert roles to string representation
      Overrides:
      toString in class Object
    • equals

      public boolean equals(Object obj)
      Compare two roles for equality
      Overrides:
      equals in class Object
      Parameters:
      obj - roles instance to compare with
    • hashCode

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