Class HighlightField.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.core.search.HighlightBase.AbstractBuilder<HighlightField.Builder>
org.opensearch.client.opensearch.core.search.HighlightField.Builder
- All Implemented Interfaces:
CopyableBuilder<HighlightField.Builder,,HighlightField> MutableBuilder<HighlightField.Builder,,HighlightField> ObjectBuilder<HighlightField>
- Enclosing class:
HighlightField
public static class HighlightField.Builder
extends HighlightBase.AbstractBuilder<HighlightField.Builder>
implements CopyableBuilder<HighlightField.Builder,HighlightField>
Builder for
HighlightField.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal HighlightField.BuilderAPI name:analyzerfinal HighlightField.BuilderAPI name:analyzerbuild()Builds aHighlightField.copy()Create a new builderCopyableBuilderthat is a copy of this one.final HighlightField.BuildermatchedFields(String value, String... values) API name:matched_fieldsfinal HighlightField.BuildermatchedFields(List<String> list) API name:matched_fieldsprotected HighlightField.Builderself()Methods inherited from class org.opensearch.client.opensearch.core.search.HighlightBase.AbstractBuilder
boundaryChars, boundaryMaxScan, boundaryScanner, boundaryScannerLocale, forceSource, fragmenter, fragmentOffset, fragmentSize, highlightFilter, highlightQuery, highlightQuery, maxAnalyzerOffset, maxFragmentLength, noMatchSize, numberOfFragments, options, options, order, phraseLimit, postTags, postTags, preTags, preTags, requireFieldMatch, tagsSchema, type, 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<HighlightField.Builder,HighlightField> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classHighlightBase.AbstractBuilder<HighlightField.Builder>
-
analyzer
API name:analyzer -
analyzer
@Nonnull public final HighlightField.Builder analyzer(Function<Analyzer.Builder, ObjectBuilder<Analyzer>> fn) API name:analyzer -
matchedFields
API name:matched_fieldsAdds all elements of
listtomatchedFields. -
matchedFields
API name:matched_fieldsAdds one or more values to
matchedFields. -
build
Builds aHighlightField.- Specified by:
buildin interfaceObjectBuilder<HighlightField>- Throws:
NullPointerException- if some of the required fields are null.
-