org.elasticsearch.index.query

Class IdsQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.index.query.QueryBuilder

org.elasticsearch.index.query.IdsQueryBuilder

All Implemented Interfaces:

ToXContent, BoostableQueryBuilder<IdsQueryBuilder>

public class IdsQueryBuilder
extends QueryBuilder
implements BoostableQueryBuilder<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

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
IdsQueryBuilder(String... types)

Method Summary

Methods

Modifier and Type	Method and Description
IdsQueryBuilder	addIds(Collection<String> ids) Adds ids to the filter.
IdsQueryBuilder	addIds(String... ids) Adds ids to the filter.
IdsQueryBuilder	boost(float boost) Sets the boost for this query.
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
IdsQueryBuilder	ids(Collection<String> ids) Adds ids to the filter.
IdsQueryBuilder	ids(String... ids) Adds ids to the filter.
IdsQueryBuilder	queryName(String queryName) Sets the query name for the filter that can be used when searching for matched_filters per hit.

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

toXContent

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IdsQueryBuilder

public IdsQueryBuilder(String... types)

Method Detail

addIds

public IdsQueryBuilder addIds(String... ids)

Adds ids to the filter.

addIds

public IdsQueryBuilder addIds(Collection<String> ids)

Adds ids to the filter.

ids

public IdsQueryBuilder ids(String... ids)

Adds ids to the filter.

ids

public IdsQueryBuilder ids(Collection<String> ids)

Adds ids to the filter.

boost

public IdsQueryBuilder boost(float boost)

Sets the boost for this query. Documents matching this query will (in addition to the normal weightings) have their score multiplied by the boost provided.

Specified by:

boost in interface BoostableQueryBuilder<IdsQueryBuilder>

queryName

public IdsQueryBuilder queryName(String queryName)

Sets the query name for the filter that can be used when searching for matched_filters per hit.

doXContent

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

Specified by:

doXContent in class QueryBuilder

Throws:

IOException