Package org.opensearch.client.opensearch._types.query_dsl

Class PercolateQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder<PercolateQuery.Builder>

org.opensearch.client.opensearch._types.query_dsl.PercolateQuery.Builder

All Implemented Interfaces:

CopyableBuilder<PercolateQuery.Builder,PercolateQuery>, MutableBuilder<PercolateQuery.Builder,PercolateQuery>, ObjectBuilder<PercolateQuery>

Enclosing class:

PercolateQuery

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

Builder for PercolateQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PercolateQuery	build()	Builds a PercolateQuery.
PercolateQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PercolateQuery.Builder	document(JsonData value)	The source of the document being percolated.
final PercolateQuery.Builder	documents(List<JsonData> list)	An array of sources of the documents being percolated.
final PercolateQuery.Builder	documents(JsonData value, JsonData... values)	An array of sources of the documents being percolated.
final PercolateQuery.Builder	field(String value)	Required - API name: field
final PercolateQuery.Builder	id(String value)	API name: id
final PercolateQuery.Builder	index(String value)	API name: index
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)	API name: routing
protected PercolateQuery.Builder	self()
final PercolateQuery.Builder	version(Long value)	API name: version

Methods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder

boost, queryName

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public PercolateQuery.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<PercolateQuery.Builder,PercolateQuery>

Returns:

a new builder instance.

self

@Nonnull
protected PercolateQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<PercolateQuery.Builder>

document

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

The source of the document being percolated.

API name: document

documents

@Nonnull
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

@Nonnull
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

@Nonnull
public final PercolateQuery.Builder field(String value)

Required - API name: field

id

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

API name: id

index

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

API name: index

name

@Nonnull
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

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

Preference used to fetch document to percolate.

API name: preference

routing

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

API name: routing

version

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

API name: version

build

@Nonnull
public PercolateQuery build()

Builds a PercolateQuery.

Specified by:

build in interface ObjectBuilder<PercolateQuery>

Throws:

NullPointerException - if some of the required fields are null.