Package co.elastic.clients.elasticsearch.core.search

Class HitsMetadata.Builder<T>

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.core.search.HitsMetadata.Builder<T>
All Implemented Interfaces:
ObjectBuilder<HitsMetadata<T>>
Enclosing class:
HitsMetadata<T>
public static class HitsMetadata.Builder<T>
extends ObjectBuilderBase
implements ObjectBuilder<HitsMetadata<T>>
Builder for HitsMetadata.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • total

      public final HitsMetadata.Builder<T> total​(@Nullable TotalHits value)
      Total hit count information, present only if track_total_hits wasn't false in the search request.

      API name: total

    • total

      public final HitsMetadata.Builder<T> total​(java.util.function.Function<TotalHits.Builder,​ObjectBuilder<TotalHits>> fn)
      Total hit count information, present only if track_total_hits wasn't false in the search request.

      API name: total

    • hits

      public final HitsMetadata.Builder<T> hits​(java.util.List<Hit<T>> list)
      Required - API name: hits

      Adds all elements of list to hits.

    • hits

      public final HitsMetadata.Builder<T> hits​(Hit<T> value, Hit<T>... values)
      Required - API name: hits

      Adds one or more values to hits.

    • hits

      public final HitsMetadata.Builder<T> hits​(java.util.function.Function<Hit.Builder<T>,​ObjectBuilder<Hit<T>>> fn)
      Required - API name: hits

      Adds a value to hits using a builder lambda.

    • maxScore

      public final HitsMetadata.Builder<T> maxScore​(@Nullable java.lang.Double value)
      API name: max_score

      Defaults to Double.NaN if parsed from a JSON null value.

    • tSerializer

      public final HitsMetadata.Builder<T> tSerializer​(@Nullable JsonpSerializer<T> value)
      Serializer for T. If not set, an attempt will be made to find a serializer from the JSON context.

    • build

      public HitsMetadata<T> build()
      Builds a HitsMetadata.
      Specified by:
      build in interface ObjectBuilder<T>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.