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

Class HitsMetadata.Builder<T>

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<HitsMetadata.Builder<T>>

co.elastic.clients.elasticsearch.core.search.HitsMetadata.Builder<T>

All Implemented Interfaces:

WithJson<HitsMetadata.Builder<T>>, ObjectBuilder<HitsMetadata<T>>

Enclosing class:

HitsMetadata<T>

public static class HitsMetadata.Builder<T>
extends WithJsonObjectBuilderBase<HitsMetadata.Builder<T>>
implements ObjectBuilder<HitsMetadata<T>>

Builder for HitsMetadata.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HitsMetadata<T>	build()	Builds a HitsMetadata.
final HitsMetadata.Builder<T>	hits(Hit<T> value, Hit<T>... values)	Required - API name: hits
final HitsMetadata.Builder<T>	hits(Function<Hit.Builder<T>,ObjectBuilder<Hit<T>>> fn)	Required - API name: hits
final HitsMetadata.Builder<T>	hits(List<Hit<T>> list)	Required - API name: hits
final HitsMetadata.Builder<T>	maxScore(Double value)	API name: max_score
protected HitsMetadata.Builder<T>	self()
final HitsMetadata.Builder<T>	total(TotalHits value)	Total hit count information, present only if track_total_hits wasn't false in the search request.
final HitsMetadata.Builder<T>	total(Function<TotalHits.Builder,ObjectBuilder<TotalHits>> fn)	Total hit count information, present only if track_total_hits wasn't false in the search request.
final HitsMetadata.Builder<T>	tSerializer(JsonpSerializer<T> value)	Serializer for T.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

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(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(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(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
 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.

self

protected HitsMetadata.Builder<T> self()

Specified by:

self in class WithJsonObjectBuilderBase<HitsMetadata.Builder<T>>

build

public HitsMetadata<T> build()

Builds a HitsMetadata.

Specified by:

build in interface ObjectBuilder<T>

Throws:

NullPointerException - if some of the required fields are null.