Package org.opensearch.client.opensearch.indices.analyze

Class ExplainAnalyzeToken

java.lang.Object
org.opensearch.client.opensearch.indices.analyze.ExplainAnalyzeToken
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<ExplainAnalyzeToken.Builder,ExplainAnalyzeToken>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class ExplainAnalyzeToken extends Object implements PlainJsonSerializable, ToCopyableBuilder<ExplainAnalyzeToken.Builder,ExplainAnalyzeToken>
The detailed token information.

  • Field Details

  • Method Details

    • of

      public static ExplainAnalyzeToken of(Function<ExplainAnalyzeToken.Builder,ObjectBuilder<ExplainAnalyzeToken>> fn)

    • bytes

      @Nonnull public final String bytes()
      Required - The bytes representation of the token.

      API name: bytes

    • endOffset

      public final int endOffset()
      Required - The ending character offset of the token.

      API name: end_offset

    • keyword

      @Nullable public final Boolean keyword()
      Whether the token is a keyword.

      API name: keyword

    • position

      public final int position()
      Required - The position of the token.

      API name: position

    • positionLength

      public final int positionLength()
      Required - The length of the token position.

      API name: positionLength

    • startOffset

      public final int startOffset()
      Required - The starting character offset of the token.

      API name: start_offset

    • termFrequency

      public final int termFrequency()
      Required - The frequency of the term.

      API name: termFrequency

    • token

      @Nonnull public final String token()
      Required - The token string.

      API name: token

    • type

      @Nonnull public final String type()
      Required - The type of the token.

      API name: type

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toBuilder

      @Nonnull public ExplainAnalyzeToken.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ExplainAnalyzeToken.Builder,ExplainAnalyzeToken>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static ExplainAnalyzeToken.Builder builder()

    • setupExplainAnalyzeTokenDeserializer

      protected static void setupExplainAnalyzeTokenDeserializer(ObjectDeserializer<ExplainAnalyzeToken.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object