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 java.lang.Object
implements Writeable, ToXContentObject

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.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 ParseField	COLLAPSE_FIELD
static QueryBuilder	DEFAULT_INNER_HIT_QUERY
static ParseField	FIELD_FIELD
static ParseField	IGNORE_UNMAPPED
static ParseField	NAME_FIELD

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

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
InnerHitBuilder	addDocValueField(java.lang.String field)	Adds a field to load from doc values and return.
InnerHitBuilder	addDocValueField(java.lang.String field, java.lang.String format)	Adds a field to load from the docvalue and return.
InnerHitBuilder	addScriptField(java.lang.String name, Script script)
InnerHitBuilder	addSort(SortBuilder<?> sort)
boolean	equals(java.lang.Object o)
static InnerHitBuilder	fromXContent(XContentParser parser)
java.util.List<DocValueFieldsContext.FieldAndFormat>	getDocValueFields()	Gets the docvalue fields.
FetchSourceContext	getFetchSourceContext()
java.util.List<java.lang.String>	getFieldNames()	Deprecated. Use getStoredFieldsContext() instead.
int	getFrom()
HighlightBuilder	getHighlightBuilder()
CollapseBuilder	getInnerCollapseBuilder()
java.lang.String	getName()
java.util.Set<SearchSourceBuilder.ScriptField>	getScriptFields()
int	getSize()
java.util.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(java.util.List<DocValueFieldsContext.FieldAndFormat> docValueFields)	Sets the stored fields to load from the docvalue and return.
InnerHitBuilder	setExplain(boolean explain)
InnerHitBuilder	setFetchSourceContext(FetchSourceContext fetchSourceContext)
InnerHitBuilder	setFieldNames(java.util.List<java.lang.String> fieldNames)	Deprecated. Use setStoredFieldNames(List) instead.
InnerHitBuilder	setFrom(int from)
InnerHitBuilder	setHighlightBuilder(HighlightBuilder highlightBuilder)
InnerHitBuilder	setIgnoreUnmapped(boolean value)
InnerHitBuilder	setInnerCollapse(CollapseBuilder innerCollapseBuilder)
InnerHitBuilder	setName(java.lang.String name)
InnerHitBuilder	setScriptFields(java.util.Set<SearchSourceBuilder.ScriptField> scriptFields)
InnerHitBuilder	setSeqNoAndPrimaryTerm(boolean seqNoAndPrimaryTerm)
InnerHitBuilder	setSize(int size)
InnerHitBuilder	setSorts(java.util.List<SortBuilder<?>> sorts)
InnerHitBuilder	setStoredFieldNames(java.util.List<java.lang.String> fieldNames)	Sets the stored fields to load and return.
InnerHitBuilder	setTrackScores(boolean trackScores)
InnerHitBuilder	setVersion(boolean version)
java.lang.String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.
void	writeToCollapseBWC(StreamOutput out)	BWC serialization for collapsing InnerHitBuilder.
protected void	writeToNestedBWC(StreamOutput out, QueryBuilder query, java.lang.String nestedPath)	BWC serialization for nested InnerHitBuilder.
void	writeToParentChildBWC(StreamOutput out, QueryBuilder query, java.lang.String parentChildPath)	BWC serialization for parent/child InnerHitBuilder.

Methods inherited from class java.lang.Object

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

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

isFragment

Field Detail

NAME_FIELD

public static final ParseField NAME_FIELD

IGNORE_UNMAPPED

public static final ParseField IGNORE_UNMAPPED

DEFAULT_INNER_HIT_QUERY

public static final QueryBuilder DEFAULT_INNER_HIT_QUERY

COLLAPSE_FIELD

public static final ParseField COLLAPSE_FIELD

FIELD_FIELD

public static final ParseField FIELD_FIELD

Constructor Detail

InnerHitBuilder

public InnerHitBuilder()

InnerHitBuilder

public InnerHitBuilder(java.lang.String name)

InnerHitBuilder

public InnerHitBuilder(StreamInput in)
                throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

writeToNestedBWC

protected void writeToNestedBWC(StreamOutput out,
                                QueryBuilder query,
                                java.lang.String nestedPath)
                         throws java.io.IOException

BWC serialization for nested InnerHitBuilder. Should only be used to send nested inner hits to nodes pre 5.5.

Throws:

java.io.IOException

writeToCollapseBWC

public void writeToCollapseBWC(StreamOutput out)
                        throws java.io.IOException

BWC serialization for collapsing InnerHitBuilder. Should only be used to send collapsing inner hits to nodes pre 5.5.

Throws:

java.io.IOException

writeToParentChildBWC

public void writeToParentChildBWC(StreamOutput out,
                                  QueryBuilder query,
                                  java.lang.String parentChildPath)
                           throws java.io.IOException

BWC serialization for parent/child InnerHitBuilder. Should only be used to send hasParent or hasChild inner hits to nodes pre 5.5.

Throws:

java.io.IOException

getName

public java.lang.String getName()

setName

public InnerHitBuilder setName(java.lang.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)

getFieldNames

@Deprecated
public java.util.List<java.lang.String> getFieldNames()

Deprecated.

Use getStoredFieldsContext() instead.

Gets the stored fields to load and return.

setFieldNames

@Deprecated
public InnerHitBuilder setFieldNames(java.util.List<java.lang.String> fieldNames)

Deprecated.

Use setStoredFieldNames(List) instead.

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

getStoredFieldsContext

public StoredFieldsContext getStoredFieldsContext()

Gets the stored fields context.

setStoredFieldNames

public InnerHitBuilder setStoredFieldNames(java.util.List<java.lang.String> fieldNames)

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

getDocValueFields

public java.util.List<DocValueFieldsContext.FieldAndFormat> getDocValueFields()

Gets the docvalue fields.

setDocValueFields

public InnerHitBuilder setDocValueFields(java.util.List<DocValueFieldsContext.FieldAndFormat> docValueFields)

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

addDocValueField

public InnerHitBuilder addDocValueField(java.lang.String field,
                                        java.lang.String format)

Adds a field to load from the docvalue and return.

addDocValueField

public InnerHitBuilder addDocValueField(java.lang.String field)

Adds a field to load from doc values and return.

getScriptFields

public java.util.Set<SearchSourceBuilder.ScriptField> getScriptFields()

setScriptFields

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

addScriptField

public InnerHitBuilder addScriptField(java.lang.String name,
                                      Script script)

getFetchSourceContext

public FetchSourceContext getFetchSourceContext()

setFetchSourceContext

public InnerHitBuilder setFetchSourceContext(FetchSourceContext fetchSourceContext)

getSorts

public java.util.List<SortBuilder<?>> getSorts()

setSorts

public InnerHitBuilder setSorts(java.util.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 java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

fromXContent

public static InnerHitBuilder fromXContent(XContentParser parser)
                                    throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object