Package org.elasticsearch.percolator

Class PercolateQueryBuilder

java.lang.Object

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

org.elasticsearch.percolator.PercolateQueryBuilder

All Implemented Interfaces:

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

public class PercolateQueryBuilder
extends AbstractQueryBuilder<PercolateQueryBuilder>

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 extends java.lang.Object>, Writeable.Writer<V extends java.lang.Object>

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, queryName

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

MAX_REWRITE_ROUNDS

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	PercolateQueryBuilder(java.lang.String field, java.lang.String indexedDocumentIndex, java.lang.String indexedDocumentType, java.lang.String indexedDocumentId, java.lang.String indexedDocumentRouting, java.lang.String indexedDocumentPreference, java.lang.Long indexedDocumentVersion)	Creates a percolator query builder instance for percolating a document in a remote index.
	PercolateQueryBuilder(java.lang.String field, java.lang.String documentType, java.lang.String indexedDocumentIndex, java.lang.String indexedDocumentType, java.lang.String indexedDocumentId, java.lang.String indexedDocumentRouting, java.lang.String indexedDocumentPreference, java.lang.Long indexedDocumentVersion)	Deprecated.
protected	PercolateQueryBuilder(java.lang.String field, java.lang.String documentType, java.util.function.Supplier<BytesReference> documentSupplier)
	PercolateQueryBuilder(java.lang.String field, java.lang.String documentType, java.util.List<BytesReference> documents, XContentType documentXContentType)	Deprecated.
	PercolateQueryBuilder(java.lang.String field, java.lang.String documentType, BytesReference document)	Deprecated. use PercolateQueryBuilder(String, BytesReference, XContentType) with the document content type to avoid autodetection.
	PercolateQueryBuilder(java.lang.String field, java.util.List<BytesReference> documents, XContentType documentXContentType)	Creates a percolator query builder instance for percolating a provided document.
	PercolateQueryBuilder(java.lang.String field, BytesReference document, XContentType documentXContentType)	Creates a percolator query builder instance for percolating a provided document.

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(PercolateQueryBuilder other)
protected int	doHashCode()
protected QueryBuilder	doRewrite(QueryRewriteContext queryShardContext)
protected org.apache.lucene.search.Query	doToQuery(QueryShardContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
static PercolateQueryBuilder	fromXContent(XContentParser parser)
java.util.List<BytesReference>	getDocuments()
java.lang.String	getDocumentType()
java.lang.String	getField()
java.lang.String	getQueryName()
java.lang.String	getWriteableName()
PercolateQueryBuilder	setName(java.lang.String name)	Sets the name used for identification purposes in _percolator_document_slot response field when multiple percolate queries have been specified in the main query.

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Details

PercolateQueryBuilder

@Deprecated public PercolateQueryBuilder(java.lang.String field, java.lang.String documentType, BytesReference document)

Deprecated.

use PercolateQueryBuilder(String, BytesReference, XContentType) with the document content type to avoid autodetection.

PercolateQueryBuilder

public PercolateQueryBuilder(java.lang.String field, BytesReference document, XContentType documentXContentType)

Creates a percolator query builder instance for percolating a provided document.

Parameters:

field - The field that contains the percolator query

document - The binary blob containing document to percolate

documentXContentType - The content type of the binary blob containing the document to percolate

PercolateQueryBuilder

public PercolateQueryBuilder(java.lang.String field, java.util.List<BytesReference> documents, XContentType documentXContentType)

Creates a percolator query builder instance for percolating a provided document.

Parameters:

field - The field that contains the percolator query

documents - The binary blob containing document to percolate

documentXContentType - The content type of the binary blob containing the document to percolate

PercolateQueryBuilder

@Deprecated public PercolateQueryBuilder(java.lang.String field, java.lang.String documentType, java.util.List<BytesReference> documents, XContentType documentXContentType)

Deprecated.

PercolateQueryBuilder

protected PercolateQueryBuilder(java.lang.String field, java.lang.String documentType, java.util.function.Supplier<BytesReference> documentSupplier)

PercolateQueryBuilder

public PercolateQueryBuilder(java.lang.String field, java.lang.String indexedDocumentIndex, java.lang.String indexedDocumentType, java.lang.String indexedDocumentId, java.lang.String indexedDocumentRouting, java.lang.String indexedDocumentPreference, java.lang.Long indexedDocumentVersion)

Creates a percolator query builder instance for percolating a document in a remote index.

Parameters:

field - The field that contains the percolator query

indexedDocumentIndex - The index containing the document to percolate

indexedDocumentType - The type containing the document to percolate

indexedDocumentId - The id of the document to percolate

indexedDocumentRouting - The routing value for the document to percolate

indexedDocumentPreference - The preference to use when fetching the document to percolate

indexedDocumentVersion - The expected version of the document to percolate

PercolateQueryBuilder

@Deprecated public PercolateQueryBuilder(java.lang.String field, java.lang.String documentType, java.lang.String indexedDocumentIndex, java.lang.String indexedDocumentType, java.lang.String indexedDocumentId, java.lang.String indexedDocumentRouting, java.lang.String indexedDocumentPreference, java.lang.Long indexedDocumentVersion)

Deprecated.

Method Details

setName

public PercolateQueryBuilder setName(java.lang.String name)

Sets the name used for identification purposes in _percolator_document_slot response field when multiple percolate queries have been specified in the main query.

doWriteTo

protected void doWriteTo(StreamOutput out) throws java.io.IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<PercolateQueryBuilder>

Throws:

java.io.IOException

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<PercolateQueryBuilder>

Throws:

java.io.IOException

fromXContent

public static PercolateQueryBuilder fromXContent(XContentParser parser) throws java.io.IOException

Throws:

java.io.IOException

doEquals

protected boolean doEquals(PercolateQueryBuilder other)

Specified by:

doEquals in class AbstractQueryBuilder<PercolateQueryBuilder>

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<PercolateQueryBuilder>

getWriteableName

public java.lang.String getWriteableName()

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryShardContext)

Overrides:

doRewrite in class AbstractQueryBuilder<PercolateQueryBuilder>

doToQuery

protected org.apache.lucene.search.Query doToQuery(QueryShardContext context) throws java.io.IOException

Specified by:

doToQuery in class AbstractQueryBuilder<PercolateQueryBuilder>

Throws:

java.io.IOException

getField

public java.lang.String getField()

getDocumentType

public java.lang.String getDocumentType()

getDocuments

public java.util.List<BytesReference> getDocuments()

getQueryName

public java.lang.String getQueryName()