Class TermvectorsRequest.Builder<TDocument>
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.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 -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aTermvectorsRequest.API name:docA 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:filterAPI name:filterThe 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_analyzerperFieldAnalyzer(Map<String, String> map) API name:per_field_analyzerSpecifies 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.Serializer for TDocument.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 org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _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:
fieldsAdds all elements of
listtofields. -
fields
A comma-separated list of fields to return.API name:
fieldsAdds 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_analyzerAdds all entries of
maptoperFieldAnalyzer. -
perFieldAnalyzer
API name:per_field_analyzerAdds 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 -
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:
buildin interfaceObjectBuilder<TDocument>- Throws:
NullPointerException- if some of the required fields are null.
-