Enum FTInfoOptions.InfoScope

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CLUSTER
      All nodes (primary and replica) are queried.
      LOCAL
      Only the executing (local) node provides index information.
      PRIMARY
      Primary nodes of every shard are queried.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static FTInfoOptions.InfoScope valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static FTInfoOptions.InfoScope[] 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

      • LOCAL

        public static final FTInfoOptions.InfoScope LOCAL
        Only the executing (local) node provides index information. This is the default.
      • PRIMARY

        public static final FTInfoOptions.InfoScope PRIMARY
        Primary nodes of every shard are queried. Only valid in cluster mode.
      • CLUSTER

        public static final FTInfoOptions.InfoScope CLUSTER
        All nodes (primary and replica) are queried. Only valid in cluster mode.
    • Method Detail

      • values

        public static FTInfoOptions.InfoScope[] 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 (FTInfoOptions.InfoScope c : FTInfoOptions.InfoScope.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static FTInfoOptions.InfoScope 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