org.elasticsearch.action.percolate

Class PercolateSourceBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.action.percolate.PercolateSourceBuilder

All Implemented Interfaces:

ToXContent

public class PercolateSourceBuilder
extends ToXContentToBytes

Builder to create the percolate request body.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PercolateSourceBuilder.DocBuilder A builder for defining the document to be percolated in various ways.

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
PercolateSourceBuilder()

Method Summary

Modifier and Type	Method and Description
PercolateSourceBuilder	addAggregation(AggregatorBuilder<?> aggregationBuilder) Add an aggregation definition.
PercolateSourceBuilder	addAggregation(PipelineAggregatorBuilder<?> aggregationBuilder) Add an aggregation definition.
PercolateSourceBuilder	addSort(SortBuilder<?> sort) Adds a sort builder.
static PercolateSourceBuilder.DocBuilder	docBuilder()
PercolateSourceBuilder	setDoc(PercolateSourceBuilder.DocBuilder docBuilder) Sets the document to run the percolate queries against.
PercolateSourceBuilder	setHighlightBuilder(HighlightBuilder highlightBuilder) Enables highlighting for the percolate document.
PercolateSourceBuilder	setQueryBuilder(QueryBuilder<?> queryBuilder) Sets a query to reduce the number of percolate queries to be evaluated and score the queries that match based on this query.
PercolateSourceBuilder	setSize(int size) Limits the maximum number of percolate query matches to be returned.
PercolateSourceBuilder	setSort(boolean sort) Similar as setTrackScores(boolean), but whether to sort by the score descending.
PercolateSourceBuilder	setTrackScores(boolean trackScores) Whether to compute a score for each match and include it in the response.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

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

PercolateSourceBuilder

public PercolateSourceBuilder()

Method Detail

setDoc

public PercolateSourceBuilder setDoc(PercolateSourceBuilder.DocBuilder docBuilder)

Sets the document to run the percolate queries against.

setQueryBuilder

public PercolateSourceBuilder setQueryBuilder(QueryBuilder<?> queryBuilder)

Sets a query to reduce the number of percolate queries to be evaluated and score the queries that match based on this query.

setSize

public PercolateSourceBuilder setSize(int size)

Limits the maximum number of percolate query matches to be returned.

setSort

public PercolateSourceBuilder setSort(boolean sort)

Similar as setTrackScores(boolean), but whether to sort by the score descending.

addSort

public PercolateSourceBuilder addSort(SortBuilder<?> sort)

Adds a sort builder. Only sorting by score desc is supported. By default the matching percolator queries are returned in an undefined order.

setTrackScores

public PercolateSourceBuilder setTrackScores(boolean trackScores)

Whether to compute a score for each match and include it in the response. The score is based on setQueryBuilder(QueryBuilder).

setHighlightBuilder

public PercolateSourceBuilder setHighlightBuilder(HighlightBuilder highlightBuilder)

Enables highlighting for the percolate document. Per matched percolate query highlight the percolate document.

addAggregation

public PercolateSourceBuilder addAggregation(AggregatorBuilder<?> aggregationBuilder)

Add an aggregation definition.

addAggregation

public PercolateSourceBuilder addAggregation(PipelineAggregatorBuilder<?> aggregationBuilder)

Add an aggregation definition.

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Throws:

java.io.IOException

docBuilder

public static PercolateSourceBuilder.DocBuilder docBuilder()

Returns:

A new PercolateSourceBuilder.DocBuilder instance.