Package org.opensearch.client.opensearch.core.search

Class InnerHits.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.InnerHits.Builder

All Implemented Interfaces:

ObjectBuilder<InnerHits>

Enclosing class:

InnerHits

public static class InnerHits.Builder
extends ObjectBuilderBase
implements ObjectBuilder<InnerHits>

Builder for InnerHits.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
InnerHits	build()	Builds a InnerHits.
InnerHits.Builder	collapse(java.util.function.Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)	API name: collapse
InnerHits.Builder	collapse(FieldCollapse value)	API name: collapse
InnerHits.Builder	docvalueFields(java.util.function.Function<FieldAndFormat.Builder,ObjectBuilder<FieldAndFormat>> fn)	API name: docvalue_fields
InnerHits.Builder	docvalueFields(java.util.List<FieldAndFormat> list)	API name: docvalue_fields
InnerHits.Builder	docvalueFields(FieldAndFormat value, FieldAndFormat... values)	API name: docvalue_fields
InnerHits.Builder	explain(java.lang.Boolean value)	API name: explain
InnerHits.Builder	fields(java.lang.String value, java.lang.String... values)	API name: fields
InnerHits.Builder	fields(java.util.List<java.lang.String> list)	API name: fields
InnerHits.Builder	from(java.lang.Integer value)	API name: from
InnerHits.Builder	highlight(java.util.function.Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)	API name: highlight
InnerHits.Builder	highlight(Highlight value)	API name: highlight
InnerHits.Builder	ignoreUnmapped(java.lang.Boolean value)	API name: ignore_unmapped
InnerHits.Builder	name(java.lang.String value)	API name: name
InnerHits.Builder	scriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)	API name: script_fields
InnerHits.Builder	scriptFields(java.lang.String key, ScriptField value)	API name: script_fields
InnerHits.Builder	scriptFields(java.util.Map<java.lang.String,ScriptField> map)	API name: script_fields
InnerHits.Builder	seqNoPrimaryTerm(java.lang.Boolean value)	API name: seq_no_primary_term
InnerHits.Builder	size(java.lang.Integer value)	API name: size
InnerHits.Builder	sort(java.util.function.Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)	API name: sort
InnerHits.Builder	sort(java.util.List<SortOptions> list)	API name: sort
InnerHits.Builder	sort(SortOptions value, SortOptions... values)	API name: sort
InnerHits.Builder	source(java.util.function.Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)	API name: _source
InnerHits.Builder	source(SourceConfig value)	API name: _source
InnerHits.Builder	storedFields(java.lang.String value, java.lang.String... values)	API name: stored_fields
InnerHits.Builder	storedFields(java.util.List<java.lang.String> list)	API name: stored_fields
InnerHits.Builder	trackScores(java.lang.Boolean value)	API name: track_scores
InnerHits.Builder	version(java.lang.Boolean value)	API name: version

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAdd, _listAddAll, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

name

public final InnerHits.Builder name(@Nullable
                                    java.lang.String value)

API name: name

size

public final InnerHits.Builder size(@Nullable
                                    java.lang.Integer value)

API name: size

from

public final InnerHits.Builder from(@Nullable
                                    java.lang.Integer value)

API name: from

collapse

public final InnerHits.Builder collapse(@Nullable
                                        FieldCollapse value)

API name: collapse

collapse

public final InnerHits.Builder collapse(java.util.function.Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)

API name: collapse

docvalueFields

public final InnerHits.Builder docvalueFields(java.util.List<FieldAndFormat> list)

API name: docvalue_fields

Adds all elements of list to docvalueFields.

docvalueFields

public final InnerHits.Builder docvalueFields(FieldAndFormat value,
                                              FieldAndFormat... values)

API name: docvalue_fields

Adds one or more values to docvalueFields.

docvalueFields

public final InnerHits.Builder docvalueFields(java.util.function.Function<FieldAndFormat.Builder,ObjectBuilder<FieldAndFormat>> fn)

API name: docvalue_fields

Adds a value to docvalueFields using a builder lambda.

explain

public final InnerHits.Builder explain(@Nullable
                                       java.lang.Boolean value)

API name: explain

highlight

public final InnerHits.Builder highlight(@Nullable
                                         Highlight value)

API name: highlight

highlight

public final InnerHits.Builder highlight(java.util.function.Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)

API name: highlight

ignoreUnmapped

public final InnerHits.Builder ignoreUnmapped(@Nullable
                                              java.lang.Boolean value)

API name: ignore_unmapped

scriptFields

public final InnerHits.Builder scriptFields(java.util.Map<java.lang.String,ScriptField> map)

API name: script_fields

Adds all entries of map to scriptFields.

scriptFields

public final InnerHits.Builder scriptFields(java.lang.String key,
                                            ScriptField value)

API name: script_fields

Adds an entry to scriptFields.

scriptFields

public final InnerHits.Builder scriptFields(java.lang.String key,
                                            java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)

API name: script_fields

Adds an entry to scriptFields using a builder lambda.

seqNoPrimaryTerm

public final InnerHits.Builder seqNoPrimaryTerm(@Nullable
                                                java.lang.Boolean value)

API name: seq_no_primary_term

fields

public final InnerHits.Builder fields(java.util.List<java.lang.String> list)

API name: fields

Adds all elements of list to fields.

fields

public final InnerHits.Builder fields(java.lang.String value,
                                      java.lang.String... values)

API name: fields

Adds one or more values to fields.

sort

public final InnerHits.Builder sort(java.util.List<SortOptions> list)

API name: sort

Adds all elements of list to sort.

sort

public final InnerHits.Builder sort(SortOptions value,
                                    SortOptions... values)

API name: sort

Adds one or more values to sort.

sort

public final InnerHits.Builder sort(java.util.function.Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)

API name: sort

Adds a value to sort using a builder lambda.

source

public final InnerHits.Builder source(@Nullable
                                      SourceConfig value)

API name: _source

source

public final InnerHits.Builder source(java.util.function.Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)

API name: _source

storedFields

public final InnerHits.Builder storedFields(java.util.List<java.lang.String> list)

API name: stored_fields

Adds all elements of list to storedFields.

storedFields

public final InnerHits.Builder storedFields(java.lang.String value,
                                            java.lang.String... values)

API name: stored_fields

Adds one or more values to storedFields.

trackScores

public final InnerHits.Builder trackScores(@Nullable
                                           java.lang.Boolean value)

API name: track_scores

version

public final InnerHits.Builder version(@Nullable
                                       java.lang.Boolean value)

API name: version

build

public InnerHits build()

Builds a InnerHits.

Specified by:

build in interface ObjectBuilder<InnerHits>

Throws:

java.lang.NullPointerException - if some of the required fields are null.