Package org.opensearch.join.query

Class ParentIdQueryBuilder

java.lang.Object

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

org.opensearch.join.query.ParentIdQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject, QueryBuilder, Rewriteable<QueryBuilder>

public final class ParentIdQueryBuilder
extends AbstractQueryBuilder<ParentIdQueryBuilder>

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

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.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ParentIdQueryBuilder(String type, String id)
ParentIdQueryBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(ParentIdQueryBuilder that)
protected int	doHashCode()
protected org.apache.lucene.search.Query	doToQuery(QueryShardContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
static ParentIdQueryBuilder	fromXContent(XContentParser parser)
String	getId()
String	getType()
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.
ParentIdQueryBuilder	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.

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

addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, 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.common.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

ParentIdQueryBuilder

public ParentIdQueryBuilder(String type,
 String id)

ParentIdQueryBuilder

public ParentIdQueryBuilder(StreamInput in)
                     throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<ParentIdQueryBuilder>

Throws:

IOException

getType

public String getType()

getId

public String getId()

ignoreUnmapped

public ParentIdQueryBuilder 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.

doXContent

protected void doXContent(XContentBuilder builder,
 ToXContent.Params params)
                   throws IOException

Specified by:

doXContent in class AbstractQueryBuilder<ParentIdQueryBuilder>

Throws:

IOException

fromXContent

public static ParentIdQueryBuilder fromXContent(XContentParser parser)
                                         throws IOException

Throws:

IOException

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<ParentIdQueryBuilder>

Throws:

IOException

doEquals

protected boolean doEquals(ParentIdQueryBuilder that)

Specified by:

doEquals in class AbstractQueryBuilder<ParentIdQueryBuilder>

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<ParentIdQueryBuilder>

getWriteableName

public String getWriteableName()