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

Class HitsMetadata<TDocument>

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<HitsMetadata.Builder<TDocument>,HitsMetadata<TDocument>>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public class HitsMetadata<TDocument>
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<HitsMetadata.Builder<TDocument>,HitsMetadata<TDocument>>

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static <TDocument> HitsMetadata.Builder	builder()
static <TDocument> JsonpDeserializer<HitsMetadata<TDocument>>	createHitsMetadataDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create a JSON deserializer for HitsMetadata.
boolean	equals(Object o)
int	hashCode()
final List<Hit<TDocument>>	hits()	Required - API name: hits
final Float	maxScore()	API name: max_score
static <TDocument> HitsMetadata<TDocument>	of(Function<HitsMetadata.Builder<TDocument>,ObjectBuilder<HitsMetadata<TDocument>>> 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 <TDocument> void	setupHitsMetadataDeserializer(ObjectDeserializer<HitsMetadata.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)
HitsMetadata.Builder<TDocument>	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final TotalHits	total()	The total number of hits, present only if track_total_hits is not set to false in the search request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

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

copy

Method Details

of

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

hits

@Nonnull
public final List<Hit<TDocument>> hits()

Required - API name: hits

maxScore

@Nullable
public final Float maxScore()

API name: max_score

total

@Nullable
public final TotalHits total()

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

API name: total

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 HitsMetadata.Builder<TDocument> 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<HitsMetadata.Builder<TDocument>,HitsMetadata<TDocument>>

Returns:

a new builder instance.

builder

@Nonnull
public static <TDocument> HitsMetadata.Builder builder()

createHitsMetadataDeserializer

public static <TDocument>
JsonpDeserializer<HitsMetadata<TDocument>> createHitsMetadataDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create a JSON deserializer for HitsMetadata.

setupHitsMetadataDeserializer

protected static <TDocument> void setupHitsMetadataDeserializer(ObjectDeserializer<HitsMetadata.Builder<TDocument>> op,
 JsonpDeserializer<TDocument> tDocumentDeserializer)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object