Class TermvectorsRequest.Builder<TDocument>
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<TermvectorsRequest.Builder<TDocument>>
co.elastic.clients.elasticsearch.core.TermvectorsRequest.Builder<TDocument>
- All Implemented Interfaces:
WithJson<TermvectorsRequest.Builder<TDocument>>
,ObjectBuilder<TermvectorsRequest<TDocument>>
- Enclosing class:
- TermvectorsRequest<TDocument>
public static class TermvectorsRequest.Builder<TDocument>
extends RequestBase.AbstractBuilder<TermvectorsRequest.Builder<TDocument>>
implements ObjectBuilder<TermvectorsRequest<TDocument>>
Builder for
TermvectorsRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aTermvectorsRequest
.API name:doc
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:filter
API name:filter
The id of the document, when not specified a doc param should be supplied.Required - The index in which the document resides.Specifies if term offsets should be returned.Specifies if term payloads should be returned.perFieldAnalyzer
(String key, String value) API name:per_field_analyzer
perFieldAnalyzer
(Map<String, String> map) API name:per_field_analyzer
Specifies if term positions should be returned.preference
(String value) Specify the node or shard the operation should be performed on (default: random).Specifies if request is real-time as opposed to near-real-time (default: true).Specific routing value.protected TermvectorsRequest.Builder<TDocument>
self()
Serializer for TDocument.termStatistics
(Boolean value) Specifies if total term frequency and document frequency should be returned.The type of the document.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
-
doc
API name:doc
-
fieldStatistics
Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.API name:
field_statistics
-
fields
A comma-separated list of fields to return.API name:
fields
Adds all elements of
list
tofields
. -
fields
A comma-separated list of fields to return.API name:
fields
Adds one or more values to
fields
. -
filter
API name:filter
-
filter
public final TermvectorsRequest.Builder<TDocument> filter(Function<Filter.Builder, ObjectBuilder<Filter>> fn) API name:filter
-
id
The id of the document, when not specified a doc param should be supplied.API name:
id
-
index
Required - The index in which the document resides.API name:
index
-
offsets
Specifies if term offsets should be returned.API name:
offsets
-
payloads
Specifies if term payloads should be returned.API name:
payloads
-
perFieldAnalyzer
API name:per_field_analyzer
Adds all entries of
map
toperFieldAnalyzer
. -
perFieldAnalyzer
API name:per_field_analyzer
Adds an entry to
perFieldAnalyzer
. -
positions
Specifies if term positions should be returned.API name:
positions
-
preference
Specify the node or shard the operation should be performed on (default: random).API name:
preference
-
realtime
Specifies if request is real-time as opposed to near-real-time (default: true).API name:
realtime
-
routing
Specific routing value.API name:
routing
-
termStatistics
Specifies if total term frequency and document frequency should be returned.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
-
tDocumentSerializer
public final TermvectorsRequest.Builder<TDocument> tDocumentSerializer(@Nullable JsonpSerializer<TDocument> value) Serializer for TDocument. If not set, an attempt will be made to find a serializer from the JSON context. -
self
- Specified by:
self
in classRequestBase.AbstractBuilder<TermvectorsRequest.Builder<TDocument>>
-
build
Builds aTermvectorsRequest
.- Specified by:
build
in interfaceObjectBuilder<TDocument>
- Throws:
NullPointerException
- if some of the required fields are null.
-