org.elasticsearch.search.fetch.innerhits

Class InnerHitsBuilder.InnerHit

java.lang.Object

org.elasticsearch.index.query.support.BaseInnerHitBuilder<InnerHitsBuilder.InnerHit>

org.elasticsearch.search.fetch.innerhits.InnerHitsBuilder.InnerHit

All Implemented Interfaces:

ToXContent

Enclosing class:

InnerHitsBuilder

public static class InnerHitsBuilder.InnerHit
extends BaseInnerHitBuilder<InnerHitsBuilder.InnerHit>

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.index.query.support.BaseInnerHitBuilder

sourceBuilder

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
InnerHitsBuilder.InnerHit()

Method Summary

Methods

Modifier and Type	Method and Description
InnerHitsBuilder.InnerHit	addInnerHit(String name, InnerHitsBuilder.InnerHit innerHit) Adds a nested inner hit definition that collects inner hits for hits on this inner hit level.
InnerHitsBuilder.InnerHit	setPath(String path) For parent/child inner hits the type to collect inner hits for.
InnerHitsBuilder.InnerHit	setQuery(QueryBuilder query) Sets the query to run for collecting the inner hits.
InnerHitsBuilder.InnerHit	setType(String type) For nested inner hits the path to collect child nested docs for.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class org.elasticsearch.index.query.support.BaseInnerHitBuilder

addFieldDataField, addHighlightedField, addHighlightedField, addHighlightedField, addHighlightedField, addHighlightedField, addScriptField, addSort, addSort, field, highlightBuilder, setExplain, setFetchSource, setFetchSource, setFetchSource, setFrom, setHighlighterBoundaryChars, setHighlighterBoundaryMaxScan, setHighlighterEncoder, setHighlighterFilter, setHighlighterFragmenter, setHighlighterFragmentSize, setHighlighterNoMatchSize, setHighlighterNumOfFragments, setHighlighterOptions, setHighlighterOrder, setHighlighterPhraseLimit, setHighlighterPostTags, setHighlighterPreTags, setHighlighterQuery, setHighlighterRequireFieldMatch, setHighlighterTagsSchema, setHighlighterType, setNoFields, setSize, setTrackScores, setVersion, sourceBuilder

Methods inherited from class java.lang.Object

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

Constructor Detail

InnerHitsBuilder.InnerHit

public InnerHitsBuilder.InnerHit()

Method Detail

setQuery

public InnerHitsBuilder.InnerHit setQuery(QueryBuilder query)

Sets the query to run for collecting the inner hits.

setPath

public InnerHitsBuilder.InnerHit setPath(String path)

For parent/child inner hits the type to collect inner hits for.

setType

public InnerHitsBuilder.InnerHit setType(String type)

For nested inner hits the path to collect child nested docs for.

addInnerHit

public InnerHitsBuilder.InnerHit addInnerHit(String name,
                                    InnerHitsBuilder.InnerHit innerHit)

Adds a nested inner hit definition that collects inner hits for hits on this inner hit level.

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Overrides:

toXContent in class BaseInnerHitBuilder<InnerHitsBuilder.InnerHit>

Throws:

IOException