Class MultiTermVectorsOperation.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.core.mtermvectors.MultiTermVectorsOperation.Builder
- All Implemented Interfaces:
CopyableBuilder<MultiTermVectorsOperation.Builder,,MultiTermVectorsOperation> MutableBuilder<MultiTermVectorsOperation.Builder,,MultiTermVectorsOperation> ObjectBuilder<MultiTermVectorsOperation>
- Enclosing class:
MultiTermVectorsOperation
public static class MultiTermVectorsOperation.Builder
extends ObjectBuilderBase
implements CopyableBuilder<MultiTermVectorsOperation.Builder,MultiTermVectorsOperation>
Builder for
MultiTermVectorsOperation.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aMultiTermVectorsOperation.copy()Create a new builderCopyableBuilderthat is a copy of this one.An artificial document for which you want to retrieve term vectors.API name:fieldsAPI name:fieldsfieldStatistics(Boolean value) Whentrue, the response includes the document count, the sum of the document frequencies, and the sum of the term frequencies.API name:filterAPI name:filterRequired - API name:_idAPI name:_indexWhentrue, the response includes the term offsets.Whentrue, the response includes the term payloads.Whentrue, the response includes the term positions.API name:routingtermStatistics(Boolean value) Whentrue, the response includes the term frequency and the document frequency.API name:versionversionType(VersionType value) API name:version_typeMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<MultiTermVectorsOperation.Builder,MultiTermVectorsOperation> - Returns:
- a new builder instance.
-
doc
An artificial document for which you want to retrieve term vectors.API name:
doc -
fieldStatistics
Whentrue, the response includes the document count, the sum of the document frequencies, and the sum of the term frequencies.API name:
field_statistics -
fields
API name:fieldsAdds all elements of
listtofields. -
fields
API name:fieldsAdds one or more values to
fields. -
filter
API name:filter -
filter
@Nonnull public final MultiTermVectorsOperation.Builder filter(Function<Filter.Builder, ObjectBuilder<Filter>> fn) API name:filter -
id
Required - API name:_id -
index
API name:_index -
offsets
Whentrue, the response includes the term offsets.API name:
offsets -
payloads
Whentrue, the response includes the term payloads.API name:
payloads -
positions
Whentrue, the response includes the term positions.API name:
positions -
routing
API name:routing -
termStatistics
Whentrue, the response includes the term frequency and the document frequency.API name:
term_statistics -
version
API name:version -
versionType
API name:version_type -
build
Builds aMultiTermVectorsOperation.- Specified by:
buildin interfaceObjectBuilder<MultiTermVectorsOperation>- Throws:
NullPointerException- if some of the required fields are null.
-