Module org.elasticsearch.server

Package org.elasticsearch.index.query

Class InnerHitBuilder

java.lang.Object

org.elasticsearch.index.query.InnerHitBuilder

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public final class InnerHitBuilder
extends Object
implements Writeable, ToXContentObject

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	COLLAPSE_FIELD
static final int	DEFAULT_FROM
static final int	DEFAULT_SIZE
static final ParseField	FIELD_FIELD
static final ParseField	IGNORE_UNMAPPED
static final ParseField	NAME_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
InnerHitBuilder()
InnerHitBuilder(String name)
InnerHitBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
InnerHitBuilder	addDocValueField(String field)	Adds a field to load from doc values and return.
InnerHitBuilder	addDocValueField(String field, String format)	Adds a field to load from the docvalue and return.
InnerHitBuilder	addFetchField(String name)	Adds a field to load and return as part of the search request.
InnerHitBuilder	addFetchField(String name, String format)	Adds a field to load and return as part of the search request.
InnerHitBuilder	addFetchField(String name, String format, Boolean includeUnmapped)	Adds a field to load and return as part of the search request.
InnerHitBuilder	addScriptField(String name, Script script)
InnerHitBuilder	addSort(SortBuilder<?> sort)
boolean	equals(Object o)
static InnerHitBuilder	fromXContent(XContentParser parser)
List<FieldAndFormat>	getDocValueFields()	Gets the docvalue fields.
List<FieldAndFormat>	getFetchFields()	Gets the fields to load and return as part of the search request.
FetchSourceContext	getFetchSourceContext()
int	getFrom()
HighlightBuilder	getHighlightBuilder()
CollapseBuilder	getInnerCollapseBuilder()
String	getName()
Set<SearchSourceBuilder.ScriptField>	getScriptFields()
int	getSize()
List<SortBuilder<?>>	getSorts()
StoredFieldsContext	getStoredFieldsContext()	Gets the stored fields context.
int	hashCode()
boolean	isExplain()
boolean	isIgnoreUnmapped()	Whether to include inner hits in the search response hits if required mappings is missing
boolean	isSeqNoAndPrimaryTerm()
boolean	isTrackScores()
boolean	isVersion()
InnerHitBuilder	setDocValueFields(List<FieldAndFormat> docValueFields)	Sets the stored fields to load from the docvalue and return.
InnerHitBuilder	setExplain(boolean explain)
InnerHitBuilder	setFetchFields(List<FieldAndFormat> fetchFields)	Sets the stored fields to load and return as part of the search request.
InnerHitBuilder	setFetchSourceContext(FetchSourceContext fetchSourceContext)
InnerHitBuilder	setFrom(int from)
InnerHitBuilder	setHighlightBuilder(HighlightBuilder highlightBuilder)
InnerHitBuilder	setIgnoreUnmapped(boolean value)
InnerHitBuilder	setInnerCollapse(CollapseBuilder innerCollapseBuilder)
InnerHitBuilder	setName(String name)
InnerHitBuilder	setScriptFields(Set<SearchSourceBuilder.ScriptField> scriptFields)
InnerHitBuilder	setSeqNoAndPrimaryTerm(boolean seqNoAndPrimaryTerm)
InnerHitBuilder	setSize(int size)
InnerHitBuilder	setSorts(List<SortBuilder<?>> sorts)
InnerHitBuilder	setStoredFieldNames(List<String> fieldNames)	Sets the stored fields to load and return.
InnerHitBuilder	setTrackScores(boolean trackScores)
InnerHitBuilder	setVersion(boolean version)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NAME_FIELD

public static final ParseField NAME_FIELD

IGNORE_UNMAPPED

public static final ParseField IGNORE_UNMAPPED

COLLAPSE_FIELD

public static final ParseField COLLAPSE_FIELD

FIELD_FIELD

public static final ParseField FIELD_FIELD

DEFAULT_FROM

public static final int DEFAULT_FROM

See Also:

• Constant Field Values

DEFAULT_SIZE

public static final int DEFAULT_SIZE

See Also:

• Constant Field Values

Constructor Details

InnerHitBuilder

public InnerHitBuilder()

InnerHitBuilder

public InnerHitBuilder(String name)

InnerHitBuilder

public InnerHitBuilder(StreamInput in)
                throws IOException

Read from a stream.

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

getName

public String getName()

setName

public InnerHitBuilder setName(String name)

setIgnoreUnmapped

public InnerHitBuilder setIgnoreUnmapped(boolean value)

isIgnoreUnmapped

public boolean isIgnoreUnmapped()

Whether to include inner hits in the search response hits if required mappings is missing

getFrom

public int getFrom()

setFrom

public InnerHitBuilder setFrom(int from)

getSize

public int getSize()

setSize

public InnerHitBuilder setSize(int size)

isExplain

public boolean isExplain()

setExplain

public InnerHitBuilder setExplain(boolean explain)

isVersion

public boolean isVersion()

setVersion

public InnerHitBuilder setVersion(boolean version)

isSeqNoAndPrimaryTerm

public boolean isSeqNoAndPrimaryTerm()

setSeqNoAndPrimaryTerm

public InnerHitBuilder setSeqNoAndPrimaryTerm(boolean seqNoAndPrimaryTerm)

isTrackScores

public boolean isTrackScores()

setTrackScores

public InnerHitBuilder setTrackScores(boolean trackScores)

getStoredFieldsContext

public StoredFieldsContext getStoredFieldsContext()

Gets the stored fields context.

setStoredFieldNames

public InnerHitBuilder setStoredFieldNames(List<String> fieldNames)

Sets the stored fields to load and return. If none are specified, the source of the document will be returned.

getDocValueFields

public List<FieldAndFormat> getDocValueFields()

Gets the docvalue fields.

setDocValueFields

public InnerHitBuilder setDocValueFields(List<FieldAndFormat> docValueFields)

Sets the stored fields to load from the docvalue and return.

addDocValueField

public InnerHitBuilder addDocValueField(String field,
 String format)

Adds a field to load from the docvalue and return.

addDocValueField

public InnerHitBuilder addDocValueField(String field)

Adds a field to load from doc values and return.

getFetchFields

public List<FieldAndFormat> getFetchFields()

Gets the fields to load and return as part of the search request.

setFetchFields

public InnerHitBuilder setFetchFields(List<FieldAndFormat> fetchFields)

Sets the stored fields to load and return as part of the search request.

addFetchField

public InnerHitBuilder addFetchField(String name)

Adds a field to load and return as part of the search request.

addFetchField

public InnerHitBuilder addFetchField(String name,
 @Nullable
 String format)

Adds a field to load and return as part of the search request.

Parameters:

name - the field name.

format - an optional format string used when formatting values, for example a date format.

addFetchField

public InnerHitBuilder addFetchField(String name,
 @Nullable
 String format,
 Boolean includeUnmapped)

Adds a field to load and return as part of the search request.

Parameters:

name - the field name.

format - an optional format string used when formatting values, for example a date format.

includeUnmapped - whether unmapped fields should be returned as well

getScriptFields

public Set<SearchSourceBuilder.ScriptField> getScriptFields()

setScriptFields

public InnerHitBuilder setScriptFields(Set<SearchSourceBuilder.ScriptField> scriptFields)

addScriptField

public InnerHitBuilder addScriptField(String name,
 Script script)

getFetchSourceContext

public FetchSourceContext getFetchSourceContext()

setFetchSourceContext

public InnerHitBuilder setFetchSourceContext(FetchSourceContext fetchSourceContext)

getSorts

public List<SortBuilder<?>> getSorts()

setSorts

public InnerHitBuilder setSorts(List<SortBuilder<?>> sorts)

addSort

public InnerHitBuilder addSort(SortBuilder<?> sort)

getHighlightBuilder

public HighlightBuilder getHighlightBuilder()

setHighlightBuilder

public InnerHitBuilder setHighlightBuilder(HighlightBuilder highlightBuilder)

setInnerCollapse

public InnerHitBuilder setInnerCollapse(CollapseBuilder innerCollapseBuilder)

getInnerCollapseBuilder

public CollapseBuilder getInnerCollapseBuilder()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

fromXContent

public static InnerHitBuilder fromXContent(XContentParser parser)
                                    throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object