Package org.elasticsearch.index.query

Class IdsQueryBuilder

java.lang.Object

org.elasticsearch.index.query.AbstractQueryBuilder<IdsQueryBuilder>

org.elasticsearch.index.query.IdsQueryBuilder

All Implemented Interfaces:

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

public class IdsQueryBuilder
extends AbstractQueryBuilder<IdsQueryBuilder>

A query that will return only documents matching specific ids (and a type).

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 String	NAME

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

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

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

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
IdsQueryBuilder()	Creates a new IdsQueryBuilder with no types specified upfront
IdsQueryBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
IdsQueryBuilder	addIds(String... ids)	Adds ids to the query.
protected boolean	doEquals(IdsQueryBuilder other)	Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
protected QueryBuilder	doRewrite(QueryRewriteContext queryRewriteContext)
protected org.apache.lucene.search.Query	doToQuery(SearchExecutionContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
static IdsQueryBuilder	fromXContent(XContentParser parser)
String	getWriteableName()	Returns the name of the writeable object
Set<String>	ids()	Returns the ids for the query.
String[]	types()	Deprecated. Types are in the process of being removed, prefer to filter on a field instead.
IdsQueryBuilder	types(String... types)	Deprecated. Types are in the process of being removed, prefer to filter on a field instead.

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

addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, 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.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

IdsQueryBuilder

public IdsQueryBuilder()

Creates a new IdsQueryBuilder with no types specified upfront

IdsQueryBuilder

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

Throws:

IOException

types

@Deprecated
public IdsQueryBuilder types(String... types)

Deprecated.

Types are in the process of being removed, prefer to filter on a field instead.

Add types to query

types

@Deprecated
public String[] types()

Deprecated.

Types are in the process of being removed, prefer to filter on a field instead.

Returns the types used in this query

addIds

public IdsQueryBuilder addIds(String... ids)

Adds ids to the query.

ids

public Set<String> ids()

Returns the ids for the query.

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<IdsQueryBuilder>

Throws:

IOException

fromXContent

public static IdsQueryBuilder fromXContent(XContentParser parser)

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext)
                          throws IOException

Overrides:

doRewrite in class AbstractQueryBuilder<IdsQueryBuilder>

Throws:

IOException

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<IdsQueryBuilder>

Throws:

IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<IdsQueryBuilder>

doEquals

protected boolean doEquals(IdsQueryBuilder 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<IdsQueryBuilder>