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) Array of existing or artificial documents.Array of existing or artificial documents.docs
(List<MultiTermVectorsOperation> list) Array of existing or artificial documents.Comma-separated list or wildcard expressions of fields to include in the statistics.Comma-separated list or wildcard expressions of fields to include in the statistics.fieldStatistics
(Boolean value) Iftrue
, the response includes the document count, sum of document frequencies, and sum of total term frequencies.Simplified syntax to specify documents by their ID if they're in the same index.Simplified syntax to specify documents by their ID if they're in the same index.Name of the index that contains the documents.Iftrue
, the response includes term offsets.Iftrue
, the response includes term payloads.Iftrue
, the response includes term positions.preference
(String value) Specifies the node or shard the operation should be performed on.If true, the request is real-time as opposed to near-real-time.Custom value used to route operations to a specific shard.protected MtermvectorsRequest.Builder
self()
termStatistics
(Boolean value) If true, the response includes term frequency and document frequency.Iftrue
, returns the document version as part of a hit.versionType
(VersionType value) Specific version type.Methods 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
Array of existing or artificial documents.API name:
docs
Adds all elements of
list
todocs
. -
docs
public final MtermvectorsRequest.Builder docs(MultiTermVectorsOperation value, MultiTermVectorsOperation... values) Array of existing or artificial documents.API name:
docs
Adds one or more values to
docs
. -
docs
public final MtermvectorsRequest.Builder docs(Function<MultiTermVectorsOperation.Builder, ObjectBuilder<MultiTermVectorsOperation>> fn) Array of existing or artificial documents.API name:
docs
Adds a value to
docs
using a builder lambda. -
fieldStatistics
Iftrue
, the response includes the document count, sum of document frequencies, and sum of total term frequencies.API name:
field_statistics
-
fields
Comma-separated list or wildcard expressions of fields to include in the statistics. Used as the default list unless a specific field list is provided in thecompletion_fields
orfielddata_fields
parameters.API name:
fields
Adds all elements of
list
tofields
. -
fields
Comma-separated list or wildcard expressions of fields to include in the statistics. Used as the default list unless a specific field list is provided in thecompletion_fields
orfielddata_fields
parameters.API name:
fields
Adds one or more values to
fields
. -
ids
Simplified syntax to specify documents by their ID if they're in the same index.API name:
ids
Adds all elements of
list
toids
. -
ids
Simplified syntax to specify documents by their ID if they're in the same index.API name:
ids
Adds one or more values to
ids
. -
index
Name of the index that contains the documents.API name:
index
-
offsets
Iftrue
, the response includes term offsets.API name:
offsets
-
payloads
Iftrue
, the response includes term payloads.API name:
payloads
-
positions
Iftrue
, the response includes term positions.API name:
positions
-
preference
Specifies the node or shard the operation should be performed on. Random by default.API name:
preference
-
realtime
If true, the request is real-time as opposed to near-real-time.API name:
realtime
-
routing
Custom value used to route operations to a specific shard.API name:
routing
-
termStatistics
If true, the response includes term frequency and document frequency.API name:
term_statistics
-
version
Iftrue
, returns the document version as part of a hit.API name:
version
-
versionType
Specific version type.API 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.
-