Class MtermvectorsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<MtermvectorsRequest.Builder>
co.elastic.clients.elasticsearch.core.MtermvectorsRequest.Builder
- All Implemented Interfaces:
WithJson<MtermvectorsRequest.Builder>
,ObjectBuilder<MtermvectorsRequest>
- Enclosing class:
- MtermvectorsRequest
public static class MtermvectorsRequest.Builder
extends RequestBase.AbstractBuilder<MtermvectorsRequest.Builder>
implements ObjectBuilder<MtermvectorsRequest>
Builder for
MtermvectorsRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aMtermvectorsRequest
.docs
(MultiTermVectorsOperation value, MultiTermVectorsOperation... values) API name:docs
API name:docs
docs
(List<MultiTermVectorsOperation> list) API name:docs
A comma-separated list of fields to return.A comma-separated list of fields to return.fieldStatistics
(Boolean value) Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.API name:ids
API name:ids
The index in which the document resides.Specifies if term offsets should be returned.Specifies if term payloads should be returned.Specifies if term positions should be returned.preference
(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".Specifies if requests are real-time as opposed to near-real-time (default: true).Specific routing value.protected MtermvectorsRequest.Builder
self()
termStatistics
(Boolean value) Specifies if total term frequency and document frequency should be returned.Explicit version number for concurrency controlversionType
(VersionType value) Specific version typeMethods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
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(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
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
-
version
Explicit version number for concurrency controlAPI name:
version
-
versionType
Specific version typeAPI name:
version_type
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<MtermvectorsRequest.Builder>
-
build
Builds aMtermvectorsRequest
.- Specified by:
build
in interfaceObjectBuilder<MtermvectorsRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-