Package org.elasticsearch.cluster.routing

Enum Preference

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Preference>, java.lang.constant.Constable
    public enum Preference
extends java.lang.Enum<Preference>
    Routing Preference Type

    • 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
      LOCAL
      Route to local node, if possible
      ONLY_LOCAL
      Route to the local shard only
      ONLY_NODES
      Route to only node with attribute
      PREFER_NODES
      Route to preferred nodes, if possible
      PRIMARY
      Route to primary shards
      PRIMARY_FIRST
      Route to primary shards first
      REPLICA
      Route to replica shards
      REPLICA_FIRST
      Route to replica shards first
      SHARDS
      Route to specific shards

    • Method Summary

      Modifier and Type Method Description
      static Preference parse​(java.lang.String preference)
      Parses the Preference Type given a string
      java.lang.String type()  
      static Preference valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Preference[] 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

    • Enum Constant Detail

      • SHARDS

        public static final Preference SHARDS
        Route to specific shards

      • PREFER_NODES

        public static final Preference PREFER_NODES
        Route to preferred nodes, if possible

      • LOCAL

        public static final Preference LOCAL
        Route to local node, if possible

      • PRIMARY

        public static final Preference PRIMARY
        Route to primary shards

      • REPLICA

        public static final Preference REPLICA
        Route to replica shards

      • PRIMARY_FIRST

        public static final Preference PRIMARY_FIRST
        Route to primary shards first

      • REPLICA_FIRST

        public static final Preference REPLICA_FIRST
        Route to replica shards first

      • ONLY_LOCAL

        public static final Preference ONLY_LOCAL
        Route to the local shard only

      • ONLY_NODES

        public static final Preference ONLY_NODES
        Route to only node with attribute

    • Method Detail

      • values

        public static Preference[] 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 Preference 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

      • type

        public java.lang.String type()

      • parse

        public static Preference parse​(java.lang.String preference)
        Parses the Preference Type given a string