Class Highlight.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.core.search.HighlightBase.AbstractBuilder<Highlight.Builder>
org.opensearch.client.opensearch.core.search.Highlight.Builder
- All Implemented Interfaces:
CopyableBuilder<Highlight.Builder,,Highlight> MutableBuilder<Highlight.Builder,,Highlight> ObjectBuilder<Highlight>
- Enclosing class:
Highlight
public static class Highlight.Builder
extends HighlightBase.AbstractBuilder<Highlight.Builder>
implements CopyableBuilder<Highlight.Builder,Highlight>
Builder for
Highlight.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aHighlight.copy()Create a new builderCopyableBuilderthat is a copy of this one.final Highlight.Builderencoder(HighlighterEncoder value) API name:encoderfinal Highlight.BuilderRequired - API name:fieldsfinal Highlight.Builderfields(String key, HighlightField value) Required - API name:fieldsfinal Highlight.Builderfields(Map<String, HighlightField> map) Required - API name:fieldsprotected Highlight.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<Highlight.Builder,Highlight> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classHighlightBase.AbstractBuilder<Highlight.Builder>
-
encoder
API name:encoder -
fields
Required - API name:fieldsAdds all elements of
maptofields. -
fields
Required - API name:fieldsAdds an entry to
fields. -
fields
@Nonnull public final Highlight.Builder fields(String key, Function<HighlightField.Builder, ObjectBuilder<HighlightField>> fn) Required - API name:fieldsAdds a value to
fieldsusing a builder lambda. -
build
Builds aHighlight.- Specified by:
buildin interfaceObjectBuilder<Highlight>- Throws:
NullPointerException- if some of the required fields are null.
-