Class MultiTermVectorsOperation.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<MultiTermVectorsOperation.Builder>
co.elastic.clients.elasticsearch.core.mtermvectors.MultiTermVectorsOperation.Builder
- All Implemented Interfaces:
WithJson<MultiTermVectorsOperation.Builder>
,ObjectBuilder<MultiTermVectorsOperation>
- Enclosing class:
- MultiTermVectorsOperation
public static class MultiTermVectorsOperation.Builder
extends WithJsonObjectBuilderBase<MultiTermVectorsOperation.Builder>
implements ObjectBuilder<MultiTermVectorsOperation>
Builder for
MultiTermVectorsOperation
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aMultiTermVectorsOperation
.An artificial document (a document not present in the index) for which you want to retrieve term vectors.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.Filter terms based on their tf-idf scores.Filter terms based on their tf-idf scores.Required - The ID of the document.The index of the document.Iftrue
, the response includes term offsets.Iftrue
, the response includes term payloads.Iftrue
, the response includes term positions.Custom value used to route operations to a specific shard.protected MultiTermVectorsOperation.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
-
id
Required - The ID of the document.API name:
_id
-
index
The index of the document.API name:
_index
-
doc
An artificial document (a document not present in the index) for which you want to retrieve term vectors.API name:
doc
-
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
. -
fieldStatistics
Iftrue
, the response includes the document count, sum of document frequencies, and sum of total term frequencies.API name:
field_statistics
-
filter
Filter terms based on their tf-idf scores.API name:
filter
-
filter
public final MultiTermVectorsOperation.Builder filter(Function<Filter.Builder, ObjectBuilder<Filter>> fn) Filter terms based on their tf-idf scores.API name:
filter
-
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
-
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 classWithJsonObjectBuilderBase<MultiTermVectorsOperation.Builder>
-
build
Builds aMultiTermVectorsOperation
.- Specified by:
build
in interfaceObjectBuilder<MultiTermVectorsOperation>
- Throws:
NullPointerException
- if some of the required fields are null.
-