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:

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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
InnerHits	build()	Builds a InnerHits.
final InnerHits.Builder	collapse(Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)	API name: collapse
final InnerHits.Builder	collapse(FieldCollapse value)	API name: collapse
InnerHits.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final InnerHits.Builder	docvalueFields(Function<FieldAndFormat.Builder,ObjectBuilder<FieldAndFormat>> fn)	API name: docvalue_fields
final InnerHits.Builder	docvalueFields(List<FieldAndFormat> list)	API name: docvalue_fields
final InnerHits.Builder	docvalueFields(FieldAndFormat value, FieldAndFormat... values)	API name: docvalue_fields
final InnerHits.Builder	explain(Boolean value)	API name: explain
final InnerHits.Builder	fields(String value, String... values)	API name: fields
final InnerHits.Builder	fields(List<String> list)	API name: fields
final InnerHits.Builder	from(Integer value)	The inner hit that initiates document offset.
final InnerHits.Builder	highlight(Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)	API name: highlight
final InnerHits.Builder	highlight(Highlight value)	API name: highlight
final InnerHits.Builder	ignoreUnmapped(Boolean value)	API name: ignore_unmapped
final InnerHits.Builder	name(String value)	API name: name
final InnerHits.Builder	scriptFields(String key, Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)	API name: script_fields
final InnerHits.Builder	scriptFields(String key, ScriptField value)	API name: script_fields
final InnerHits.Builder	scriptFields(Map<String,ScriptField> map)	API name: script_fields
final InnerHits.Builder	seqNoPrimaryTerm(Boolean value)	API name: seq_no_primary_term
final InnerHits.Builder	size(Integer value)	The maximum number of hits to return per inner_hits.
final InnerHits.Builder	sort(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)	API name: sort
final InnerHits.Builder	sort(List<SortOptions> list)	API name: sort
final InnerHits.Builder	sort(SortOptions value, SortOptions... values)	API name: sort
final InnerHits.Builder	source(Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)	API name: _source
final InnerHits.Builder	source(SourceConfig value)	API name: _source
final InnerHits.Builder	storedFields(String value, String... values)	API name: stored_fields
final InnerHits.Builder	storedFields(List<String> list)	API name: stored_fields
final InnerHits.Builder	trackScores(Boolean value)	API name: track_scores
final InnerHits.Builder	version(Boolean value)	API name: version

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

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public InnerHits.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<InnerHits.Builder,InnerHits>

Returns:

a new builder instance.

collapse

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

API name: collapse

collapse

@Nonnull
public final InnerHits.Builder collapse(Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)

API name: collapse

docvalueFields

@Nonnull
public final InnerHits.Builder docvalueFields(List<FieldAndFormat> list)

API name: docvalue_fields

Adds all elements of list to docvalueFields.

docvalueFields

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

API name: docvalue_fields

Adds one or more values to docvalueFields.

docvalueFields

@Nonnull
public final InnerHits.Builder docvalueFields(Function<FieldAndFormat.Builder,ObjectBuilder<FieldAndFormat>> fn)

API name: docvalue_fields

Adds a value to docvalueFields using a builder lambda.

explain

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

API name: explain

fields

@Nonnull
public final InnerHits.Builder fields(List<String> list)

API name: fields

Adds all elements of list to fields.

fields

@Nonnull
public final InnerHits.Builder fields(String value,
 String... values)

API name: fields

Adds one or more values to fields.

from

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

The inner hit that initiates document offset.

API name: from

highlight

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

API name: highlight

highlight

@Nonnull
public final InnerHits.Builder highlight(Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)

API name: highlight

ignoreUnmapped

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

API name: ignore_unmapped

name

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

API name: name

scriptFields

@Nonnull
public final InnerHits.Builder scriptFields(Map<String,ScriptField> map)

API name: script_fields

Adds all elements of map to scriptFields.

scriptFields

@Nonnull
public final InnerHits.Builder scriptFields(String key,
 ScriptField value)

API name: script_fields

Adds an entry to scriptFields.

scriptFields

@Nonnull
public final InnerHits.Builder scriptFields(String key,
 Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)

API name: script_fields

Adds a value to scriptFields using a builder lambda.

seqNoPrimaryTerm

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

API name: seq_no_primary_term

size

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

The maximum number of hits to return per inner_hits.

API name: size

sort

@Nonnull
public final InnerHits.Builder sort(List<SortOptions> list)

API name: sort

Adds all elements of list to sort.

sort

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

API name: sort

Adds one or more values to sort.

sort

@Nonnull
public final InnerHits.Builder sort(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)

API name: sort

Adds a value to sort using a builder lambda.

source

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

API name: _source

source

@Nonnull
public final InnerHits.Builder source(Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)

API name: _source

storedFields

@Nonnull
public final InnerHits.Builder storedFields(List<String> list)

API name: stored_fields

Adds all elements of list to storedFields.

storedFields

@Nonnull
public final InnerHits.Builder storedFields(String value,
 String... values)

API name: stored_fields

Adds one or more values to storedFields.

trackScores

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

API name: track_scores

version

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

API name: version

build

@Nonnull
public InnerHits build()

Builds a InnerHits.

Specified by:

build in interface ObjectBuilder<InnerHits>

Throws:

NullPointerException - if some of the required fields are null.