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
,ToXContent
,ToXContentObject
,QueryBuilder
,Rewriteable<QueryBuilder>
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.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 java.lang.String
NAME
Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName
-
Constructor Summary
Constructors Constructor Description IdsQueryBuilder()
Creates a new IdsQueryBuilder with no types specified upfrontIdsQueryBuilder(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description IdsQueryBuilder
addIds(java.lang.String... ids)
Adds ids to the query.protected boolean
doEquals(IdsQueryBuilder other)
Indicates whether some otherQueryBuilder
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(QueryShardContext context)
protected void
doWriteTo(StreamOutput out)
protected void
doXContent(XContentBuilder builder, ToXContent.Params params)
static IdsQueryBuilder
fromXContent(XContentParser parser)
java.lang.String
getWriteableName()
Returns the name of the writeable objectjava.util.Set<java.lang.String>
ids()
Returns the ids for the query.java.lang.String[]
types()
Deprecated.Types are in the process of being removed, prefer to filter on a field instead.IdsQueryBuilder
types(java.lang.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, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
-
Constructor Details
-
IdsQueryBuilder
public IdsQueryBuilder()Creates a new IdsQueryBuilder with no types specified upfront -
IdsQueryBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractQueryBuilder<IdsQueryBuilder>
- Throws:
java.io.IOException
-
types
Deprecated.Types are in the process of being removed, prefer to filter on a field instead.Add types to query -
types
@Deprecated public java.lang.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
Adds ids to the query. -
ids
public java.util.Set<java.lang.String> ids()Returns the ids for the query. -
doXContent
protected void doXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
doXContent
in classAbstractQueryBuilder<IdsQueryBuilder>
- Throws:
java.io.IOException
-
fromXContent
-
getWriteableName
public java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object -
doRewrite
protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext) throws java.io.IOException- Overrides:
doRewrite
in classAbstractQueryBuilder<IdsQueryBuilder>
- Throws:
java.io.IOException
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(QueryShardContext context) throws java.io.IOException- Specified by:
doToQuery
in classAbstractQueryBuilder<IdsQueryBuilder>
- Throws:
java.io.IOException
-
doHashCode
protected int doHashCode()- Specified by:
doHashCode
in classAbstractQueryBuilder<IdsQueryBuilder>
-
doEquals
Description copied from class:AbstractQueryBuilder
Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.- Specified by:
doEquals
in classAbstractQueryBuilder<IdsQueryBuilder>
-