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

Class HitsMetadata<T>

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class HitsMetadata<T>
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HitsMetadata.Builder<T>	Builder for HitsMetadata.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<HitsMetadata<Object>>	_DESERIALIZER	Json deserializer for HitsMetadata based on named deserializers provided by the calling JsonMapper.

Method Summary

Modifier and Type	Method	Description
static <T> JsonpDeserializer<HitsMetadata<T>>	createHitsMetadataDeserializer(JsonpDeserializer<T> tDeserializer)	Create a JSON deserializer for HitsMetadata
final List<Hit<T>>	hits()	Required - API name: hits
final Double	maxScore()	API name: max_score
static <T> HitsMetadata<T>	of(Function<HitsMetadata.Builder<T>,ObjectBuilder<HitsMetadata<T>>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <T> void	setupHitsMetadataDeserializer(ObjectDeserializer<HitsMetadata.Builder<T>> op, JsonpDeserializer<T> tDeserializer)
String	toString()
final TotalHits	total()	Total hit count information, present only if track_total_hits wasn't false in the search request.

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<HitsMetadata<Object>> _DESERIALIZER

Json deserializer for HitsMetadata based on named deserializers provided by the calling JsonMapper.

Method Details

of

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

total

@Nullable
public final TotalHits total()

Total hit count information, present only if track_total_hits wasn't false in the search request.

API name: total

hits

public final List<Hit<T>> hits()

Required - API name: hits

maxScore

@Nullable
public final Double maxScore()

API name: max_score

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

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)

toString

public String toString()

Overrides:

toString in class Object

createHitsMetadataDeserializer

public static <T>
JsonpDeserializer<HitsMetadata<T>> createHitsMetadataDeserializer(JsonpDeserializer<T> tDeserializer)

Create a JSON deserializer for HitsMetadata

setupHitsMetadataDeserializer

protected static <T> void setupHitsMetadataDeserializer(ObjectDeserializer<HitsMetadata.Builder<T>> op,
 JsonpDeserializer<T> tDeserializer)