Class TermvectorsRequest.Builder<TDocument>
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.core.TermvectorsRequest.Builder<TDocument>
- All Implemented Interfaces:
ObjectBuilder<TermvectorsRequest<TDocument>>
- Enclosing class:
- TermvectorsRequest<TDocument>
public static class TermvectorsRequest.Builder<TDocument> extends ObjectBuilderBase implements ObjectBuilder<TermvectorsRequest<TDocument>>
Builder for
TermvectorsRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description TermvectorsRequest<TDocument>
build()
Builds aTermvectorsRequest
.TermvectorsRequest.Builder<TDocument>
doc(TDocument value)
API name:doc
TermvectorsRequest.Builder<TDocument>
fields(java.lang.String value, java.lang.String... values)
A comma-separated list of fields to return.TermvectorsRequest.Builder<TDocument>
fields(java.util.List<java.lang.String> list)
A comma-separated list of fields to return.TermvectorsRequest.Builder<TDocument>
fieldStatistics(java.lang.Boolean value)
Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.TermvectorsRequest.Builder<TDocument>
filter(Filter value)
API name:filter
TermvectorsRequest.Builder<TDocument>
filter(java.util.function.Function<Filter.Builder,ObjectBuilder<Filter>> fn)
API name:filter
TermvectorsRequest.Builder<TDocument>
id(java.lang.String value)
The id of the document, when not specified a doc param should be supplied.TermvectorsRequest.Builder<TDocument>
index(java.lang.String value)
Required - The index in which the document resides.TermvectorsRequest.Builder<TDocument>
offsets(java.lang.Boolean value)
Specifies if term offsets should be returned.TermvectorsRequest.Builder<TDocument>
payloads(java.lang.Boolean value)
Specifies if term payloads should be returned.TermvectorsRequest.Builder<TDocument>
perFieldAnalyzer(java.lang.String key, java.lang.String value)
API name:per_field_analyzer
TermvectorsRequest.Builder<TDocument>
perFieldAnalyzer(java.util.Map<java.lang.String,java.lang.String> map)
API name:per_field_analyzer
TermvectorsRequest.Builder<TDocument>
positions(java.lang.Boolean value)
Specifies if term positions should be returned.TermvectorsRequest.Builder<TDocument>
preference(java.lang.String value)
Specify the node or shard the operation should be performed on (default: random).TermvectorsRequest.Builder<TDocument>
realtime(java.lang.Boolean value)
Specifies if request is real-time as opposed to near-real-time (default: true).TermvectorsRequest.Builder<TDocument>
routing(java.lang.String value)
Specific routing value.TermvectorsRequest.Builder<TDocument>
tDocumentSerializer(JsonpSerializer<TDocument> value)
Serializer for TDocument.TermvectorsRequest.Builder<TDocument>
termStatistics(java.lang.Boolean value)
Specifies if total term frequency and document frequency should be returned.TermvectorsRequest.Builder<TDocument>
version(java.lang.Long value)
Explicit version number for concurrency controlTermvectorsRequest.Builder<TDocument>
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
-
doc
API name:doc
-
fieldStatistics
public final TermvectorsRequest.Builder<TDocument> fieldStatistics(@Nullable java.lang.Boolean value)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
public final TermvectorsRequest.Builder<TDocument> fields(java.lang.String value, java.lang.String... values)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(java.util.function.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
public final TermvectorsRequest.Builder<TDocument> perFieldAnalyzer(java.util.Map<java.lang.String,java.lang.String> map)API name:per_field_analyzer
Adds all entries of
map
toperFieldAnalyzer
. -
perFieldAnalyzer
public final TermvectorsRequest.Builder<TDocument> perFieldAnalyzer(java.lang.String key, java.lang.String value)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
public final TermvectorsRequest.Builder<TDocument> termStatistics(@Nullable java.lang.Boolean value)Specifies if total term frequency and document frequency should be returned.API name:
term_statistics
-
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. -
build
Builds aTermvectorsRequest
.- Specified by:
build
in interfaceObjectBuilder<TDocument>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-