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

Class PercolateQuery.Builder

java.lang.Object

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

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

All Implemented Interfaces:

ObjectBuilder<PercolateQuery>

Enclosing class:

PercolateQuery

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

Builder for PercolateQuery.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PercolateQuery.Builder	addDocuments(jakarta.json.JsonValue value)	Add a value to documents(List), creating the list if needed.
PercolateQuery	build()	Builds a PercolateQuery.
PercolateQuery.Builder	document(jakarta.json.JsonValue value)	API name: document
PercolateQuery.Builder	documents(jakarta.json.JsonValue... value)	API name: documents
PercolateQuery.Builder	documents(java.util.List<jakarta.json.JsonValue> value)	API name: documents
PercolateQuery.Builder	field(java.lang.String value)	API name: field
PercolateQuery.Builder	id(java.lang.String value)	API name: id
PercolateQuery.Builder	index(java.lang.String value)	API name: index
PercolateQuery.Builder	preference(java.lang.String value)	API name: preference
PercolateQuery.Builder	routing(jakarta.json.JsonValue value)	API name: routing
protected PercolateQuery.Builder	self()
PercolateQuery.Builder	version(java.lang.Number value)	API name: version

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

boost, name

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

document

public PercolateQuery.Builder document(@Nullable jakarta.json.JsonValue value)

API name: document

documents

public PercolateQuery.Builder documents(@Nullable java.util.List<jakarta.json.JsonValue> value)

API name: documents

documents

public PercolateQuery.Builder documents(jakarta.json.JsonValue... value)

API name: documents

addDocuments

public PercolateQuery.Builder addDocuments(jakarta.json.JsonValue value)

Add a value to documents(List), creating the list if needed.

field

public PercolateQuery.Builder field(@Nullable java.lang.String value)

API name: field

id

public PercolateQuery.Builder id(@Nullable java.lang.String value)

API name: id

index

public PercolateQuery.Builder index(@Nullable java.lang.String value)

API name: index

preference

public PercolateQuery.Builder preference(@Nullable java.lang.String value)

API name: preference

routing

public PercolateQuery.Builder routing(@Nullable jakarta.json.JsonValue value)

API name: routing

version

public PercolateQuery.Builder version(@Nullable java.lang.Number value)

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:

java.lang.NullPointerException - if some of the required fields are null.