Enum DiscoveryNode.Role

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DiscoveryNode.Role>, java.lang.constant.Constable
    Enclosing class:
    DiscoveryNode

    public static enum DiscoveryNode.Role
    extends java.lang.Enum<DiscoveryNode.Role>
    Enum that holds all the possible roles that that a node can fulfill in a cluster. Each role has its name and a corresponding abbreviation used by cat apis.
    • Nested Class Summary

      • Nested classes/interfaces inherited from class java.lang.Enum

        java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DATA  
      INGEST  
      MASTER  
    • Method Summary

      Modifier and Type Method Description
      java.lang.String getAbbreviation()  
      java.lang.String getRoleName()  
      static DiscoveryNode.Role valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DiscoveryNode.Role[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • values

        public static DiscoveryNode.Role[] values()
        Returns an array containing the constants of this enum type, in the order they are declared.
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static DiscoveryNode.Role valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getRoleName

        public java.lang.String getRoleName()
      • getAbbreviation

        public java.lang.String getAbbreviation()