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 -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aPercolateQuery.copy()Create a new builderCopyableBuilderthat is a copy of this one.final PercolateQuery.BuilderThe source of the document being percolated.final PercolateQuery.BuilderAn array of sources of the documents being percolated.final PercolateQuery.BuilderAn array of sources of the documents being percolated.final PercolateQuery.BuilderRequired - API name:fieldfinal PercolateQuery.BuilderAPI name:idfinal PercolateQuery.BuilderAPI name:indexfinal PercolateQuery.BuilderThe suffix used for the_percolator_document_slotfield when multiplepercolatequeries are specified.final PercolateQuery.Builderpreference(String value) Preference used to fetch document to percolate.final PercolateQuery.BuilderAPI name:routingprotected PercolateQuery.Builderself()final PercolateQuery.BuilderAPI name:versionMethods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder
boost, queryNameMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<PercolateQuery.Builder,PercolateQuery> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classQueryBase.AbstractBuilder<PercolateQuery.Builder>
-
document
The source of the document being percolated.API name:
document -
documents
An array of sources of the documents being percolated.API name:
documentsAdds all elements of
listtodocuments. -
documents
An array of sources of the documents being percolated.API name:
documentsAdds one or more values to
documents. -
field
Required - API name:field -
id
API name:id -
index
API name:index -
name
The suffix used for the_percolator_document_slotfield when multiplepercolatequeries are specified.API name:
name -
preference
Preference used to fetch document to percolate.API name:
preference -
routing
API name:routing -
version
API name:version -
build
Builds aPercolateQuery.- Specified by:
buildin interfaceObjectBuilder<PercolateQuery>- Throws:
NullPointerException- if some of the required fields are null.
-