Package org.opensearch.index.query

Class ScriptQueryBuilder

java.lang.Object

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

org.opensearch.index.query.ScriptQueryBuilder

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 ScriptQueryBuilder
extends AbstractQueryBuilder<ScriptQueryBuilder>

Query builder for script queries

Opensearch.internal:

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 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
ScriptQueryBuilder(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.
ScriptQueryBuilder(Script script)

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(ScriptQueryBuilder other)	Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
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 builderParams)
static ScriptQueryBuilder	fromXContent(org.opensearch.core.xcontent.XContentParser parser)
String	getWriteableName()
Script	script()

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

Constructor Details

ScriptQueryBuilder

public ScriptQueryBuilder(Script script)

ScriptQueryBuilder

public ScriptQueryBuilder(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<ScriptQueryBuilder>

Throws:

IOException

script

public Script script()

getWriteableName

public String getWriteableName()

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<ScriptQueryBuilder>

Throws:

IOException

fromXContent

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

Throws:

IOException

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<ScriptQueryBuilder>

Throws:

IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<ScriptQueryBuilder>

doEquals

protected boolean doEquals(ScriptQueryBuilder other)

Description copied from class: AbstractQueryBuilder

Indicates whether some other QueryBuilder object of the same type is "equal to" this one.

Specified by:

doEquals in class AbstractQueryBuilder<ScriptQueryBuilder>