HitsMetadata (java-client 7.16.3 API)

java.lang.Object

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

All Implemented Interfaces:: JsonpSerializable

public class HitsMetadata<T>
extends java.lang.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.

Method Summary

Modifier and Type	Method	Description
`static <T> JsonpDeserializer<HitsMetadata<T>>`	`createHitsMetadataDeserializer(JsonpDeserializer<T> tDeserializer)`	Create a JSON deserializer for HitsMetadata
`java.util.List<Hit<T>>`	`hits()`	Required - API name: `hits`
`java.lang.Double`	`maxScore()`	API name: `max_score`
`static <T> HitsMetadata<T>`	`of(java.util.function.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)`
`TotalHits`	`total()`	Required - API name: `total`

Methods inherited from class java.lang.Object

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

Method Details
- of
  
  public static <T> HitsMetadata<T> of(java.util.function.Function<HitsMetadata.Builder<T>,ObjectBuilder<HitsMetadata<T>>> fn)
- total
  
  public final TotalHits total()
  
  Required - API name: total
- hits
  
  public final java.util.List<Hit<T>> hits()
  
  Required - API name: hits
- maxScore
  
  @Nullable public final java.lang.Double maxScore()
  
  API name: max_score
- 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)
- 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)