Package co.elastic.clients.elasticsearch._types.query_dsl

Class PercolateQuery.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.query_dsl.QueryBase.AbstractBuilder<PercolateQuery.Builder>

co.elastic.clients.elasticsearch._types.query_dsl.PercolateQuery.Builder

All Implemented Interfaces:

WithJson<PercolateQuery.Builder>, ObjectBuilder<PercolateQuery>

Enclosing class:

PercolateQuery

public static class PercolateQuery.Builder
extends QueryBase.AbstractBuilder<PercolateQuery.Builder>
implements ObjectBuilder<PercolateQuery>

Builder for PercolateQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PercolateQuery	build()	Builds a PercolateQuery.
final PercolateQuery.Builder	document(JsonData value)	The source of the document being percolated.
final PercolateQuery.Builder	documents(JsonData value, JsonData... values)	An array of sources of the documents being percolated.
final PercolateQuery.Builder	documents(List<JsonData> list)	An array of sources of the documents being percolated.
final PercolateQuery.Builder	field(String value)	Required - Field that holds the indexed queries.
final PercolateQuery.Builder	id(String value)	The ID of a stored document to percolate.
final PercolateQuery.Builder	index(String value)	The index of a stored document to percolate.
final PercolateQuery.Builder	name(String value)	The suffix used for the _percolator_document_slot field when multiple percolate queries are specified.
final PercolateQuery.Builder	preference(String value)	Preference used to fetch document to percolate.
final PercolateQuery.Builder	routing(String value)	Routing used to fetch document to percolate.
protected PercolateQuery.Builder	self()
final PercolateQuery.Builder	version(Long value)	The expected version of a stored document to percolate.

Methods inherited from class co.elastic.clients.elasticsearch._types.query_dsl.QueryBase.AbstractBuilder

boost, queryName

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

document

public final PercolateQuery.Builder document(@Nullable
 JsonData value)

The source of the document being percolated.

API name: document

documents

public final PercolateQuery.Builder documents(List<JsonData> list)

An array of sources of the documents being percolated.

API name: documents

Adds all elements of list to documents.

documents

public final PercolateQuery.Builder documents(JsonData value,
 JsonData... values)

An array of sources of the documents being percolated.

API name: documents

Adds one or more values to documents.

field

public final PercolateQuery.Builder field(String value)

Required - Field that holds the indexed queries. The field must use the percolator mapping type.

API name: field

id

public final PercolateQuery.Builder id(@Nullable
 String value)

The ID of a stored document to percolate.

API name: id

index

public final PercolateQuery.Builder index(@Nullable
 String value)

The index of a stored document to percolate.

API name: index

name

public final PercolateQuery.Builder name(@Nullable
 String value)

The suffix used for the _percolator_document_slot field when multiple percolate queries are specified.

API name: name

preference

public final PercolateQuery.Builder preference(@Nullable
 String value)

Preference used to fetch document to percolate.

API name: preference

routing

public final PercolateQuery.Builder routing(@Nullable
 String value)

Routing used to fetch document to percolate.

API name: routing

version

public final PercolateQuery.Builder version(@Nullable
 Long value)

The expected version of a stored document to percolate.

API name: version

self

protected PercolateQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<PercolateQuery.Builder>

build

public PercolateQuery build()

Builds a PercolateQuery.

Specified by:

build in interface ObjectBuilder<PercolateQuery>

Throws:

NullPointerException - if some of the required fields are null.