Package org.opensearch.client.opensearch.core.search

Class HitsMetadata.Builder<TDocument>

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.HitsMetadata.Builder<TDocument>

All Implemented Interfaces:

CopyableBuilder<HitsMetadata.Builder<TDocument>,HitsMetadata<TDocument>>, MutableBuilder<HitsMetadata.Builder<TDocument>,HitsMetadata<TDocument>>, ObjectBuilder<HitsMetadata<TDocument>>

Enclosing class:

HitsMetadata<TDocument>

public static class HitsMetadata.Builder<TDocument>
extends ObjectBuilderBase
implements CopyableBuilder<HitsMetadata.Builder<TDocument>,HitsMetadata<TDocument>>

Builder for HitsMetadata.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HitsMetadata<TDocument>	build()	Builds a HitsMetadata.
HitsMetadata.Builder<TDocument>	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final HitsMetadata.Builder<TDocument>	hits(Function<Hit.Builder<TDocument>,ObjectBuilder<Hit<TDocument>>> fn)	Required - API name: hits
final HitsMetadata.Builder<TDocument>	hits(List<Hit<TDocument>> list)	Required - API name: hits
final HitsMetadata.Builder<TDocument>	hits(Hit<TDocument> value, Hit<TDocument>... values)	Required - API name: hits
final HitsMetadata.Builder<TDocument>	maxScore(Float value)	API name: max_score
final HitsMetadata.Builder<TDocument>	total(Function<TotalHits.Builder,ObjectBuilder<TotalHits>> fn)	The total number of hits, present only if track_total_hits is not set to false in the search request.
final HitsMetadata.Builder<TDocument>	total(TotalHits value)	The total number of hits, present only if track_total_hits is not set to false in the search request.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public HitsMetadata.Builder<TDocument> copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<HitsMetadata.Builder<TDocument>,HitsMetadata<TDocument>>

Returns:

a new builder instance.

hits

@Nonnull
public final HitsMetadata.Builder<TDocument> hits(List<Hit<TDocument>> list)

Required - API name: hits

Adds all elements of list to hits.

hits

@Nonnull
public final HitsMetadata.Builder<TDocument> hits(Hit<TDocument> value,
 Hit<TDocument>... values)

Required - API name: hits

Adds one or more values to hits.

hits

@Nonnull
public final HitsMetadata.Builder<TDocument> hits(Function<Hit.Builder<TDocument>,ObjectBuilder<Hit<TDocument>>> fn)

Required - API name: hits

Adds a value to hits using a builder lambda.

maxScore

@Nonnull
public final HitsMetadata.Builder<TDocument> maxScore(@Nullable
 Float value)

API name: max_score

total

@Nonnull
public final HitsMetadata.Builder<TDocument> total(@Nullable
 TotalHits value)

The total number of hits, present only if track_total_hits is not set to false in the search request.

API name: total

total

@Nonnull
public final HitsMetadata.Builder<TDocument> total(Function<TotalHits.Builder,ObjectBuilder<TotalHits>> fn)

The total number of hits, present only if track_total_hits is not set to false in the search request.

API name: total

build

@Nonnull
public HitsMetadata<TDocument> build()

Builds a HitsMetadata.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

NullPointerException - if some of the required fields are null.