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:

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.
PercolateQuery.Builder	document(JsonData value)	API name: document
PercolateQuery.Builder	documents(java.util.List<JsonData> list)	API name: documents
PercolateQuery.Builder	documents(JsonData value, JsonData... values)	API name: documents
PercolateQuery.Builder	field(java.lang.String value)	Required - 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	name(java.lang.String value)	API name: name
PercolateQuery.Builder	preference(java.lang.String value)	API name: preference
PercolateQuery.Builder	routing(java.lang.String value)	API name: routing
protected PercolateQuery.Builder	self()
PercolateQuery.Builder	version(java.lang.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, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

document

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

API name: document

documents

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

API name: documents

Adds all elements of list to documents.

documents

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

API name: documents

Adds one or more values to documents.

field

public final PercolateQuery.Builder field(java.lang.String value)

Required - API name: field

id

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

API name: id

index

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

API name: index

name

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

API name: name

preference

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

API name: preference

routing

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

API name: routing

version

public final PercolateQuery.Builder version(@Nullable
                                            java.lang.Long 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.