Package com.eventstore.dbclient

Enum NodePreference

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<NodePreference>
    public enum NodePreference
extends java.lang.Enum<NodePreference>
    Indicates which order of preferred nodes for connecting to.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FOLLOWER
      When attempting connection, prefers follower nodes.
      LEADER
      When attempting connection, prefers leader nodes.
      RANDOM
      When attempting connection, has no node preference.
      READ_ONLY_REPLICA
      When attempting connection, prefers read-replica nodes.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static NodePreference valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static NodePreference[] 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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • LEADER

        public static final NodePreference LEADER
        When attempting connection, prefers leader nodes.

      • FOLLOWER

        public static final NodePreference FOLLOWER
        When attempting connection, prefers follower nodes.

      • READ_ONLY_REPLICA

        public static final NodePreference READ_ONLY_REPLICA
        When attempting connection, prefers read-replica nodes.

      • RANDOM

        public static final NodePreference RANDOM
        When attempting connection, has no node preference.

    • Method Detail

      • values

        public static NodePreference[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (NodePreference c : NodePreference.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static NodePreference 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