Class InnerHits.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.core.search.InnerHits.Builder
- All Implemented Interfaces:
CopyableBuilder<InnerHits.Builder,,InnerHits> MutableBuilder<InnerHits.Builder,,InnerHits> ObjectBuilder<InnerHits>
- Enclosing class:
InnerHits
public static class InnerHits.Builder
extends ObjectBuilderBase
implements CopyableBuilder<InnerHits.Builder,InnerHits>
Builder for
InnerHits.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aInnerHits.final InnerHits.BuilderAPI name:collapsefinal InnerHits.Buildercollapse(FieldCollapse value) API name:collapsecopy()Create a new builderCopyableBuilderthat is a copy of this one.final InnerHits.BuilderAPI name:docvalue_fieldsfinal InnerHits.BuilderdocvalueFields(List<FieldAndFormat> list) API name:docvalue_fieldsfinal InnerHits.BuilderdocvalueFields(FieldAndFormat value, FieldAndFormat... values) API name:docvalue_fieldsfinal InnerHits.BuilderAPI name:explainfinal InnerHits.BuilderAPI name:fieldsfinal InnerHits.BuilderAPI name:fieldsfinal InnerHits.BuilderThe inner hit that initiates document offset.final InnerHits.BuilderAPI name:highlightfinal InnerHits.BuilderAPI name:highlightfinal InnerHits.BuilderignoreUnmapped(Boolean value) API name:ignore_unmappedfinal InnerHits.BuilderAPI name:namefinal InnerHits.BuilderAPI name:script_fieldsfinal InnerHits.BuilderscriptFields(String key, ScriptField value) API name:script_fieldsfinal InnerHits.BuilderscriptFields(Map<String, ScriptField> map) API name:script_fieldsfinal InnerHits.BuilderseqNoPrimaryTerm(Boolean value) API name:seq_no_primary_termfinal InnerHits.BuilderThe maximum number of hits to return perinner_hits.final InnerHits.BuilderAPI name:sortfinal InnerHits.Buildersort(List<SortOptions> list) API name:sortfinal InnerHits.Buildersort(SortOptions value, SortOptions... values) API name:sortfinal InnerHits.BuilderAPI name:_sourcefinal InnerHits.Buildersource(SourceConfig value) API name:_sourcefinal InnerHits.BuilderstoredFields(String value, String... values) API name:stored_fieldsfinal InnerHits.BuilderstoredFields(List<String> list) API name:stored_fieldsfinal InnerHits.BuildertrackScores(Boolean value) API name:track_scoresfinal InnerHits.BuilderAPI name:versionMethods 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<InnerHits.Builder,InnerHits> - Returns:
- a new builder instance.
-
collapse
API name:collapse -
collapse
@Nonnull public final InnerHits.Builder collapse(Function<FieldCollapse.Builder, ObjectBuilder<FieldCollapse>> fn) API name:collapse -
docvalueFields
API name:docvalue_fieldsAdds all elements of
listtodocvalueFields. -
docvalueFields
@Nonnull public final InnerHits.Builder docvalueFields(FieldAndFormat value, FieldAndFormat... values) API name:docvalue_fieldsAdds one or more values to
docvalueFields. -
docvalueFields
@Nonnull public final InnerHits.Builder docvalueFields(Function<FieldAndFormat.Builder, ObjectBuilder<FieldAndFormat>> fn) API name:docvalue_fieldsAdds a value to
docvalueFieldsusing a builder lambda. -
explain
API name:explain -
fields
API name:fieldsAdds all elements of
listtofields. -
fields
API name:fieldsAdds one or more values to
fields. -
from
The inner hit that initiates document offset.API name:
from -
highlight
API name:highlight -
highlight
@Nonnull public final InnerHits.Builder highlight(Function<Highlight.Builder, ObjectBuilder<Highlight>> fn) API name:highlight -
ignoreUnmapped
API name:ignore_unmapped -
name
API name:name -
scriptFields
API name:script_fieldsAdds all elements of
maptoscriptFields. -
scriptFields
API name:script_fieldsAdds an entry to
scriptFields. -
scriptFields
@Nonnull public final InnerHits.Builder scriptFields(String key, Function<ScriptField.Builder, ObjectBuilder<ScriptField>> fn) API name:script_fieldsAdds a value to
scriptFieldsusing a builder lambda. -
seqNoPrimaryTerm
API name:seq_no_primary_term -
size
The maximum number of hits to return perinner_hits.API name:
size -
sort
API name:sortAdds all elements of
listtosort. -
sort
API name:sortAdds one or more values to
sort. -
sort
@Nonnull public final InnerHits.Builder sort(Function<SortOptions.Builder, ObjectBuilder<SortOptions>> fn) API name:sortAdds a value to
sortusing a builder lambda. -
source
API name:_source -
source
@Nonnull public final InnerHits.Builder source(Function<SourceConfig.Builder, ObjectBuilder<SourceConfig>> fn) API name:_source -
storedFields
API name:stored_fieldsAdds all elements of
listtostoredFields. -
storedFields
API name:stored_fieldsAdds one or more values to
storedFields. -
trackScores
API name:track_scores -
version
API name:version -
build
Builds aInnerHits.- Specified by:
buildin interfaceObjectBuilder<InnerHits>- Throws:
NullPointerException- if some of the required fields are null.
-