Enum Class InputType

java.lang.Object
java.lang.Enum<InputType>
org.elasticsearch.inference.InputType
All Implemented Interfaces:
Serializable, Comparable<InputType>, Constable

public enum InputType extends Enum<InputType>
Defines the type of request, whether the request is to ingest a document or search for a document.
  • Enum Constant Details

    • INGEST

      public static final InputType INGEST
    • UNSPECIFIED

      public static final InputType UNSPECIFIED
    • CLASSIFICATION

      public static final InputType CLASSIFICATION
    • CLUSTERING

      public static final InputType CLUSTERING
    • INTERNAL_INGEST

      public static final InputType INTERNAL_INGEST
  • Method Details

    • values

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

      public static InputType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • toString

      public String toString()
      Overrides:
      toString in class Enum<InputType>
    • fromString

      public static InputType fromString(String name)
    • fromRestString

      public static InputType fromRestString(String name)
    • isInternalTypeOrUnspecified

      public static boolean isInternalTypeOrUnspecified(InputType inputType)
    • isSpecified

      public static boolean isSpecified(InputType inputType)
    • invalidInputTypeMessage

      public static String invalidInputTypeMessage(InputType inputType)
    • validateInputTypeTranslationValues

      public static Map<InputType,String> validateInputTypeTranslationValues(Map<String,Object> inputTypeTranslation, ValidationException validationException)
      Ensures that a map used for translating input types is valid. The keys of the map are the external representation, and the values correspond to the values in this class. Throws a ValidationException if any value is not a valid InputType.
      Parameters:
      inputTypeTranslation - the map of input type translations to validate
      validationException - a ValidationException to which errors will be added