java.lang.Object
- org.opensearch.client.opensearch.core.search.Hit<TDocument>

All Implemented Interfaces:: JsonpSerializable

public class Hit<TDocument>
extends java.lang.Object
implements JsonpSerializable

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Hit.Builder<TDocument>
Builder for Hit.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static <TDocument> JsonpDeserializer<Hit<TDocument>>`	`createHitDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)`	Create a JSON deserializer for Hit
`Explanation`	`explanation()`	API name: `_explanation`
`java.util.Map<java.lang.String,JsonData>`	`fields()`	API name: `fields`
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`highlight()`	API name: `highlight`
`java.lang.String`	`id()`	API name: `_id`
`java.util.List<java.lang.String>`	`ignored()`	API name: `_ignored`
`java.lang.String`	`index()`	Required - API name: `_index`
`java.util.Map<java.lang.String,InnerHitsResult>`	`innerHits()`	API name: `inner_hits`
`java.util.List<java.lang.String>`	`matchedQueries()`	API name: `matched_queries`
`NestedIdentity`	`nested()`	API name: `_nested`
`java.lang.String`	`node()`	API name: `_node`
`static <TDocument> Hit<TDocument>`	`of(java.util.function.Function<Hit.Builder<TDocument>,ObjectBuilder<Hit<TDocument>>> fn)`
`java.lang.Long`	`primaryTerm()`	API name: `_primary_term`
`java.lang.String`	`routing()`	API name: `_routing`
`java.lang.Double`	`score()`	API name: `_score`
`java.lang.Long`	`seqNo()`	API name: `_seq_no`
`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`	`setupHitDeserializer(ObjectDeserializer<Hit.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)`
`java.lang.String`	`shard()`	API name: `_shard`
`java.util.List<java.lang.String>`	`sort()`	API name: `sort`
`TDocument`	`source()`	API name: `_source`
`java.lang.Long`	`version()`	API name: `_version`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

of

public static <TDocument> Hit<TDocument> of(java.util.function.Function<Hit.Builder<TDocument>,ObjectBuilder<Hit<TDocument>>> fn)

index
```
public final java.lang.String index()
```
Required - API name: _index

id

@Nullable
public final java.lang.String id()

API name: _id

score

@Nullable
public final java.lang.Double score()

API name: _score

explanation

@Nullable
public final Explanation explanation()

API name: _explanation

fields

public final java.util.Map<java.lang.String,JsonData> fields()

API name: fields

highlight

public final java.util.Map<java.lang.String,java.util.List<java.lang.String>> highlight()

API name: highlight

innerHits

public final java.util.Map<java.lang.String,InnerHitsResult> innerHits()

API name: inner_hits

matchedQueries

public final java.util.List<java.lang.String> matchedQueries()

API name: matched_queries

nested

@Nullable
public final NestedIdentity nested()

API name: _nested

ignored

public final java.util.List<java.lang.String> ignored()

API name: _ignored

shard

@Nullable
public final java.lang.String shard()

API name: _shard

node

@Nullable
public final java.lang.String node()

API name: _node

routing

@Nullable
public final java.lang.String routing()

API name: _routing

source

@Nullable
public final TDocument source()

API name: _source

seqNo

@Nullable
public final java.lang.Long seqNo()

API name: _seq_no

primaryTerm

@Nullable
public final java.lang.Long primaryTerm()

API name: _primary_term

version

@Nullable
public final java.lang.Long version()

API name: _version

sort

public final java.util.List<java.lang.String> sort()

API name: sort

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)

createHitDeserializer

public static <TDocument> JsonpDeserializer<Hit<TDocument>> createHitDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create a JSON deserializer for Hit

setupHitDeserializer

protected static <TDocument> void setupHitDeserializer(ObjectDeserializer<Hit.Builder<TDocument>> op,
                                                       JsonpDeserializer<TDocument> tDocumentDeserializer)

Class Hit<TDocument>

Nested Class Summary