Package org.opensearch.client.opensearch._global.search

Class InnerHits.Builder

java.lang.Object

org.opensearch.client.opensearch._global.search.InnerHits.Builder

All Implemented Interfaces:

ObjectBuilder<InnerHits>

Enclosing class:

InnerHits

public static class InnerHits.Builder
extends java.lang.Object
implements ObjectBuilder<InnerHits>

Builder for InnerHits.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
InnerHits.Builder	addDocvalueFields(java.lang.String value)	Add a value to docvalueFields(List), creating the list if needed.
InnerHits.Builder	addFields(java.lang.String value)	Add a value to fields(List), creating the list if needed.
InnerHits.Builder	addSort(jakarta.json.JsonValue value)	Add a value to sort(List), creating the list if needed.
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.lang.String... value)	API name: docvalue_fields
InnerHits.Builder	docvalueFields(java.util.List<java.lang.String> value)	API name: docvalue_fields
InnerHits.Builder	explain(java.lang.Boolean value)	API name: explain
InnerHits.Builder	fields(java.lang.String... value)	API name: fields
InnerHits.Builder	fields(java.util.List<java.lang.String> value)	API name: fields
InnerHits.Builder	from(java.lang.Number 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	putScriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)	Add a key/value to scriptFields(Map), creating the map if needed.
InnerHits.Builder	putScriptFields(java.lang.String key, ScriptField value)	Add a key/value to scriptFields(Map), creating the map if needed.
InnerHits.Builder	scriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)	Set scriptFields(Map) to a singleton map.
InnerHits.Builder	scriptFields(java.util.Map<java.lang.String,ScriptField> value)	API name: script_fields
InnerHits.Builder	seqNoPrimaryTerm(java.lang.Boolean value)	API name: seq_no_primary_term
InnerHits.Builder	size(java.lang.Number value)	API name: size
InnerHits.Builder	sort(jakarta.json.JsonValue... value)	API name: sort
InnerHits.Builder	sort(java.util.List<jakarta.json.JsonValue> value)	API name: sort
InnerHits.Builder	source(jakarta.json.JsonValue value)	API name: _source
InnerHits.Builder	version(java.lang.Boolean value)	API name: version

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

name

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

API name: name

size

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

API name: size

from

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

API name: from

collapse

public InnerHits.Builder collapse(@Nullable FieldCollapse value)

API name: collapse

collapse

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

API name: collapse

docvalueFields

public InnerHits.Builder docvalueFields(@Nullable java.util.List<java.lang.String> value)

API name: docvalue_fields

docvalueFields

public InnerHits.Builder docvalueFields(java.lang.String... value)

API name: docvalue_fields

addDocvalueFields

public InnerHits.Builder addDocvalueFields(java.lang.String value)

Add a value to docvalueFields(List), creating the list if needed.

explain

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

API name: explain

highlight

public InnerHits.Builder highlight(@Nullable Highlight value)

API name: highlight

highlight

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

API name: highlight

ignoreUnmapped

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

API name: ignore_unmapped

scriptFields

public InnerHits.Builder scriptFields(@Nullable java.util.Map<java.lang.String,ScriptField> value)

API name: script_fields

putScriptFields

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

Add a key/value to scriptFields(Map), creating the map if needed.

scriptFields

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

Set scriptFields(Map) to a singleton map.

putScriptFields

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

Add a key/value to scriptFields(Map), creating the map if needed.

seqNoPrimaryTerm

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

API name: seq_no_primary_term

fields

public InnerHits.Builder fields(@Nullable java.util.List<java.lang.String> value)

API name: fields

fields

public InnerHits.Builder fields(java.lang.String... value)

API name: fields

addFields

public InnerHits.Builder addFields(java.lang.String value)

Add a value to fields(List), creating the list if needed.

sort

public InnerHits.Builder sort(@Nullable java.util.List<jakarta.json.JsonValue> value)

API name: sort

sort

public InnerHits.Builder sort(jakarta.json.JsonValue... value)

API name: sort

addSort

public InnerHits.Builder addSort(jakarta.json.JsonValue value)

Add a value to sort(List), creating the list if needed.

source

public InnerHits.Builder source(@Nullable jakarta.json.JsonValue value)

API name: _source

version

public 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.