Package org.opensearch.join.query

Class HasParentQueryBuilder

java.lang.Object

org.opensearch.index.query.AbstractQueryBuilder<HasParentQueryBuilder>

org.opensearch.join.query.HasParentQueryBuilder

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject, QueryBuilder, Rewriteable<QueryBuilder>

public class HasParentQueryBuilder
extends AbstractQueryBuilder<HasParentQueryBuilder>

Builder for the 'has_parent' query.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_IGNORE_UNMAPPED	The default value for ignore_unmapped.
static final String	NAME

Fields inherited from class org.opensearch.index.query.AbstractQueryBuilder

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

Fields inherited from interface org.opensearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
HasParentQueryBuilder(String type, QueryBuilder query, boolean score)
HasParentQueryBuilder(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(HasParentQueryBuilder that)
protected int	doHashCode()
protected QueryBuilder	doRewrite(QueryRewriteContext queryShardContext)
protected org.apache.lucene.search.Query	doToQuery(QueryShardContext context)
protected void	doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
protected void	doXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
protected void	extractInnerHitBuilders(Map<String,InnerHitContextBuilder> innerHits)
static HasParentQueryBuilder	fromXContent(org.opensearch.core.xcontent.XContentParser parser)
String	getWriteableName()
boolean	ignoreUnmapped()	Gets whether the query builder will ignore unmapped types (and run a MatchNoDocsQuery in place of this query) or throw an exception if the type is unmapped.
HasParentQueryBuilder	ignoreUnmapped(boolean ignoreUnmapped)	Sets whether the query builder should ignore unmapped types (and run a MatchNoDocsQuery in place of this query) or throw an exception if the type is unmapped.
InnerHitBuilder	innerHit()	Returns inner hit definition in the scope of this query and reusing the defined type and query.
HasParentQueryBuilder	innerHit(InnerHitBuilder innerHit)
QueryBuilder	query()	Returns the query to execute.
boolean	score()	Returns true if the parent score is mapped into the child documents
String	type()	Returns the parents type name

Methods inherited from class org.opensearch.index.query.AbstractQueryBuilder

addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, equals, getName, hashCode, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.index.query.QueryBuilder

visit

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

DEFAULT_IGNORE_UNMAPPED

public static final boolean DEFAULT_IGNORE_UNMAPPED

The default value for ignore_unmapped.

See Also:

• Constant Field Values

Constructor Details

HasParentQueryBuilder

public HasParentQueryBuilder(String type,
 QueryBuilder query,
 boolean score)

HasParentQueryBuilder

public HasParentQueryBuilder(org.opensearch.core.common.io.stream.StreamInput in)
                      throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<HasParentQueryBuilder>

Throws:

IOException

query

public QueryBuilder query()

Returns the query to execute.

score

public boolean score()

Returns true if the parent score is mapped into the child documents

type

public String type()

Returns the parents type name

innerHit

public InnerHitBuilder innerHit()

Returns inner hit definition in the scope of this query and reusing the defined type and query.

innerHit

public HasParentQueryBuilder innerHit(InnerHitBuilder innerHit)

ignoreUnmapped

public HasParentQueryBuilder ignoreUnmapped(boolean ignoreUnmapped)

Sets whether the query builder should ignore unmapped types (and run a MatchNoDocsQuery in place of this query) or throw an exception if the type is unmapped.

ignoreUnmapped

public boolean ignoreUnmapped()

Gets whether the query builder will ignore unmapped types (and run a MatchNoDocsQuery in place of this query) or throw an exception if the type is unmapped.

doToQuery

protected org.apache.lucene.search.Query doToQuery(QueryShardContext context)
                                            throws IOException

Specified by:

doToQuery in class AbstractQueryBuilder<HasParentQueryBuilder>

Throws:

IOException

doXContent

protected void doXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                   throws IOException

Specified by:

doXContent in class AbstractQueryBuilder<HasParentQueryBuilder>

Throws:

IOException

fromXContent

public static HasParentQueryBuilder fromXContent(org.opensearch.core.xcontent.XContentParser parser)
                                          throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

doEquals

protected boolean doEquals(HasParentQueryBuilder that)

Specified by:

doEquals in class AbstractQueryBuilder<HasParentQueryBuilder>

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<HasParentQueryBuilder>

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryShardContext)
                          throws IOException

Overrides:

doRewrite in class AbstractQueryBuilder<HasParentQueryBuilder>

Throws:

IOException

extractInnerHitBuilders

protected void extractInnerHitBuilders(Map<String,InnerHitContextBuilder> innerHits)

Overrides:

extractInnerHitBuilders in class AbstractQueryBuilder<HasParentQueryBuilder>