Class MtermvectorsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.core.MtermvectorsRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<MtermvectorsRequest>
- Enclosing class:
- MtermvectorsRequest
public static class MtermvectorsRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<MtermvectorsRequest>
Builder for
MtermvectorsRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description MtermvectorsRequest
build()
Builds aMtermvectorsRequest
.MtermvectorsRequest.Builder
docs(MultiTermVectorsOperation value, MultiTermVectorsOperation... values)
API name:docs
MtermvectorsRequest.Builder
docs(java.util.function.Function<MultiTermVectorsOperation.Builder,ObjectBuilder<MultiTermVectorsOperation>> fn)
API name:docs
MtermvectorsRequest.Builder
docs(java.util.List<MultiTermVectorsOperation> list)
API name:docs
MtermvectorsRequest.Builder
fields(java.lang.String value, java.lang.String... values)
A comma-separated list of fields to return.MtermvectorsRequest.Builder
fields(java.util.List<java.lang.String> list)
A comma-separated list of fields to return.MtermvectorsRequest.Builder
fieldStatistics(java.lang.Boolean value)
Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.MtermvectorsRequest.Builder
ids(java.lang.String value, java.lang.String... values)
API name:ids
MtermvectorsRequest.Builder
ids(java.util.List<java.lang.String> list)
API name:ids
MtermvectorsRequest.Builder
index(java.lang.String value)
The index in which the document resides.MtermvectorsRequest.Builder
offsets(java.lang.Boolean value)
Specifies if term offsets should be returned.MtermvectorsRequest.Builder
payloads(java.lang.Boolean value)
Specifies if term payloads should be returned.MtermvectorsRequest.Builder
positions(java.lang.Boolean value)
Specifies if term positions should be returned.MtermvectorsRequest.Builder
preference(java.lang.String value)
Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs".MtermvectorsRequest.Builder
realtime(java.lang.Boolean value)
Specifies if requests are real-time as opposed to near-real-time (default: true).MtermvectorsRequest.Builder
routing(java.lang.String value)
Specific routing value.MtermvectorsRequest.Builder
termStatistics(java.lang.Boolean value)
Specifies if total term frequency and document frequency should be returned.MtermvectorsRequest.Builder
type(java.lang.String value)
The type of the document.MtermvectorsRequest.Builder
version(java.lang.Long value)
Explicit version number for concurrency controlMtermvectorsRequest.Builder
versionType(VersionType value)
Specific version typeMethods 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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
docs
API name:docs
Adds all elements of
list
todocs
. -
docs
public final MtermvectorsRequest.Builder docs(MultiTermVectorsOperation value, MultiTermVectorsOperation... values)API name:docs
Adds one or more values to
docs
. -
docs
public final MtermvectorsRequest.Builder docs(java.util.function.Function<MultiTermVectorsOperation.Builder,ObjectBuilder<MultiTermVectorsOperation>> fn)API name:docs
Adds a value to
docs
using a builder lambda. -
fieldStatistics
Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".API name:
field_statistics
-
fields
A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs".API name:
fields
Adds all elements of
list
tofields
. -
fields
public final MtermvectorsRequest.Builder fields(java.lang.String value, java.lang.String... values)A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs".API name:
fields
Adds one or more values to
fields
. -
ids
API name:ids
Adds all elements of
list
toids
. -
ids
API name:ids
Adds one or more values to
ids
. -
index
The index in which the document resides.API name:
index
-
offsets
Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".API name:
offsets
-
payloads
Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".API name:
payloads
-
positions
Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".API name:
positions
-
preference
Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs".API name:
preference
-
realtime
Specifies if requests are real-time as opposed to near-real-time (default: true).API name:
realtime
-
routing
Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs".API name:
routing
-
termStatistics
Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".API name:
term_statistics
-
type
The type of the document.API name:
type
-
version
Explicit version number for concurrency controlAPI name:
version
-
versionType
Specific version typeAPI name:
version_type
-
build
Builds aMtermvectorsRequest
.- Specified by:
build
in interfaceObjectBuilder<MtermvectorsRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-