SearchHit (core 5.0.2 API)

All Superinterfaces:

java.lang.Iterable<SearchHitField>, Streamable, ToXContent

All Known Implementing Classes:

InternalSearchHit
```
public interface SearchHit
extends Streamable, ToXContent, java.lang.Iterable<SearchHitField>
```
A single search hit.

See Also:

SearchHits

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface SearchHit.NestedIdentity
Encapsulates the nested identity of a hit.
- Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
  ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`SearchHit.NestedIdentity` Encapsulates the nested identity of a hit.

Field Summary
- Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
  EMPTY_PARAMS

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`org.apache.lucene.search.Explanation`	`explanation()` If enabled, the explanation of the search hit.
`SearchHitField`	`field(java.lang.String fieldName)` The hit field matching the given field name.
`java.util.Map<java.lang.String,SearchHitField>`	`fields()` A map of hit fields (from field name to hit fields) if additional fields were required to be loaded.
`org.apache.lucene.search.Explanation`	`getExplanation()` If enabled, the explanation of the search hit.
`java.util.Map<java.lang.String,SearchHitField>`	`getFields()` A map of hit fields (from field name to hit fields) if additional fields were required to be loaded.
`java.util.Map<java.lang.String,HighlightField>`	`getHighlightFields()` A map of highlighted fields.
`java.lang.String`	`getId()` The id of the document.
`java.lang.String`	`getIndex()` The index of the hit.
`java.util.Map<java.lang.String,SearchHits>`	`getInnerHits()`
`java.lang.String[]`	`getMatchedQueries()` The set of query and filter names the query matched with.
`SearchHit.NestedIdentity`	`getNestedIdentity()` If this is a nested hit then nested reference information is returned otherwise `null` is returned.
`float`	`getScore()` The score.
`SearchShardTarget`	`getShard()` The shard of the search hit.
`java.lang.Object[]`	`getSortValues()` An array of the sort values used.
`java.util.Map<java.lang.String,java.lang.Object>`	`getSource()` The source of the document as a map (can be `null`).
`java.lang.String`	`getSourceAsString()` The source of the document as string (can be `null`).
`BytesReference`	`getSourceRef()` Returns bytes reference, also un compress the source if needed.
`java.lang.String`	`getType()` The type of the document.
`long`	`getVersion()` The version of the hit.
`boolean`	`hasSource()` Is the source available or not.
`java.util.Map<java.lang.String,HighlightField>`	`highlightFields()` A map of highlighted fields.
`java.lang.String`	`id()` The id of the document.
`java.lang.String`	`index()` The index of the hit.
`java.lang.String[]`	`matchedQueries()` The set of query and filter names the query matched with.
`float`	`score()` The score.
`SearchShardTarget`	`shard()` The shard of the search hit.
`java.lang.Object[]`	`sortValues()` An array of the sort values used.
`byte[]`	`source()` The source of the document (can be `null`).
`java.util.Map<java.lang.String,java.lang.Object>`	`sourceAsMap()` The source of the document as a map (can be `null`).
`java.lang.String`	`sourceAsString()` The source of the document as string (can be `null`).
`BytesReference`	`sourceRef()` Returns bytes reference, also un compress the source if needed.
`java.lang.String`	`type()` The type of the document.
`long`	`version()` The version of the hit.

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable
readFrom, writeTo

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent
toXContent

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Method Detail
  - score
```
float score()
```
    The score.
  - getScore
```
float getScore()
```
    The score.
  - index
```
java.lang.String index()
```
    The index of the hit.
  - getIndex
```
java.lang.String getIndex()
```
    The index of the hit.
  - id
```
java.lang.String id()
```
    The id of the document.
  - getId
```
java.lang.String getId()
```
    The id of the document.
  - type
```
java.lang.String type()
```
    The type of the document.
  - getType
```
java.lang.String getType()
```
    The type of the document.
  - getNestedIdentity
```
SearchHit.NestedIdentity getNestedIdentity()
```
    If this is a nested hit then nested reference information is returned otherwise null is returned.
  - version
```
long version()
```
    The version of the hit.
  - getVersion
```
long getVersion()
```
    The version of the hit.
  - sourceRef
```
BytesReference sourceRef()
```
    Returns bytes reference, also un compress the source if needed.
  - getSourceRef
```
BytesReference getSourceRef()
```
    Returns bytes reference, also un compress the source if needed.
  - source
```
byte[] source()
```
    The source of the document (can be null). Note, its a copy of the source into a byte array, consider using sourceRef() so there won't be a need to copy.
  - hasSource
```
boolean hasSource()
```
    Is the source available or not. A source with no fields will return true. This will return false if fields doesn't contain _source or if source is disabled in the mapping.
  - getSource
```
java.util.Map<java.lang.String,java.lang.Object> getSource()
```
    The source of the document as a map (can be null).
  - sourceAsString
```
java.lang.String sourceAsString()
```
    The source of the document as string (can be null).
  - getSourceAsString
```
java.lang.String getSourceAsString()
```
    The source of the document as string (can be null).
  - sourceAsMap
```
java.util.Map<java.lang.String,java.lang.Object> sourceAsMap()
                                                      throws ElasticsearchParseException
```
    The source of the document as a map (can be null).
    
    Throws:
    
    ElasticsearchParseException
  - explanation
```
org.apache.lucene.search.Explanation explanation()
```
    If enabled, the explanation of the search hit.
  - getExplanation
```
org.apache.lucene.search.Explanation getExplanation()
```
    If enabled, the explanation of the search hit.
  - field
```
SearchHitField field(java.lang.String fieldName)
```
    The hit field matching the given field name.
  - fields
```
java.util.Map<java.lang.String,SearchHitField> fields()
```
    A map of hit fields (from field name to hit fields) if additional fields were required to be loaded.
  - getFields
```
java.util.Map<java.lang.String,SearchHitField> getFields()
```
    A map of hit fields (from field name to hit fields) if additional fields were required to be loaded.
  - highlightFields
```
java.util.Map<java.lang.String,HighlightField> highlightFields()
```
    A map of highlighted fields.
  - getHighlightFields
```
java.util.Map<java.lang.String,HighlightField> getHighlightFields()
```
    A map of highlighted fields.
  - sortValues
```
java.lang.Object[] sortValues()
```
    An array of the sort values used.
  - getSortValues
```
java.lang.Object[] getSortValues()
```
    An array of the sort values used.
  - matchedQueries
```
java.lang.String[] matchedQueries()
```
    The set of query and filter names the query matched with. Mainly makes sense for compound filters and queries.
  - getMatchedQueries
```
java.lang.String[] getMatchedQueries()
```
    The set of query and filter names the query matched with. Mainly makes sense for compound filters and queries.
  - shard
```
SearchShardTarget shard()
```
    The shard of the search hit.
  - getShard
```
SearchShardTarget getShard()
```
    The shard of the search hit.
  - getInnerHits
```
java.util.Map<java.lang.String,SearchHits> getInnerHits()
```
    Returns:
    
    Inner hits or null if there are none

Interface SearchHit

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

Method Summary

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

Methods inherited from interface java.lang.Iterable

Method Detail

score

getScore

index

getIndex

id

getId

type

getType

getNestedIdentity

version

getVersion

sourceRef

getSourceRef

source

hasSource

getSource

sourceAsString

getSourceAsString

sourceAsMap

explanation

getExplanation

field

fields

getFields

highlightFields

getHighlightFields

sortValues

getSortValues

matchedQueries

getMatchedQueries

shard

getShard

getInnerHits