org.elasticsearch.index.query
Class IdsFilterBuilder
java.lang.Object
org.elasticsearch.index.query.BaseFilterBuilder
org.elasticsearch.index.query.IdsFilterBuilder
- All Implemented Interfaces:
- ToXContent, FilterBuilder
public class IdsFilterBuilder
- extends BaseFilterBuilder
A filter that will return only documents matching specific ids (and a type).
Constructor Summary |
IdsFilterBuilder(java.lang.String... types)
Create an ids filter based on the type. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
IdsFilterBuilder
public IdsFilterBuilder(java.lang.String... types)
- Create an ids filter based on the type.
addIds
public IdsFilterBuilder addIds(java.lang.String... ids)
- Adds ids to the filter.
ids
public IdsFilterBuilder ids(java.lang.String... ids)
- Adds ids to the filter.
filterName
public IdsFilterBuilder filterName(java.lang.String filterName)
- Sets the filter name for the filter that can be used when searching for matched_filters per hit.
doXContent
public void doXContent(XContentBuilder builder,
ToXContent.Params params)
throws java.io.IOException
- Specified by:
doXContent
in class BaseFilterBuilder
- Throws:
java.io.IOException