Package co.elastic.clients.elasticsearch.core.search

Class InnerHits.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<InnerHits.Builder>

co.elastic.clients.elasticsearch.core.search.InnerHits.Builder

All Implemented Interfaces:

WithJson<InnerHits.Builder>, ObjectBuilder<InnerHits>

Enclosing class:

InnerHits

public static class InnerHits.Builder
extends WithJsonObjectBuilderBase<InnerHits.Builder>
implements ObjectBuilder<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(FieldCollapse value)	API name: collapse
final InnerHits.Builder	collapse(Function<FieldCollapse.Builder,ObjectBuilder<FieldCollapse>> fn)	API name: collapse
final InnerHits.Builder	docvalueFields(FieldAndFormat value, FieldAndFormat... values)	API name: docvalue_fields
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	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)	Inner hit starting document offset.
final InnerHits.Builder	highlight(Highlight value)	API name: highlight
final InnerHits.Builder	highlight(Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)	API name: highlight
final InnerHits.Builder	ignoreUnmapped(Boolean value)	API name: ignore_unmapped
final InnerHits.Builder	name(String value)	The name for the particular inner hit definition in the response.
final InnerHits.Builder	scriptFields(String key, ScriptField value)	API name: script_fields
final InnerHits.Builder	scriptFields(String key, Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)	API name: script_fields
final InnerHits.Builder	scriptFields(Map<String,ScriptField> map)	API name: script_fields
protected InnerHits.Builder	self()
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(SortOptions value, SortOptions... values)	How the inner hits should be sorted per inner_hits.
final InnerHits.Builder	sort(Function<SortOptions.Builder,ObjectBuilder<SortOptions>> fn)	How the inner hits should be sorted per inner_hits.
final InnerHits.Builder	sort(List<SortOptions> list)	How the inner hits should be sorted per inner_hits.
final InnerHits.Builder	source(SourceConfig value)	API name: _source
final InnerHits.Builder	source(Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)	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 co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

name

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

The name for the particular inner hit definition in the response. Useful when a search request contains multiple inner hits.

API name: name

size

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

The maximum number of hits to return per inner_hits.

API name: size

from

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

Inner hit starting document offset.

API name: from

collapse

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

API name: collapse

collapse

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

API name: collapse

docvalueFields

public final InnerHits.Builder docvalueFields(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(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
 Boolean value)

API name: explain

highlight

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

API name: highlight

highlight

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

API name: highlight

ignoreUnmapped

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

API name: ignore_unmapped

scriptFields

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

API name: script_fields

Adds all entries of map to scriptFields.

scriptFields

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

API name: script_fields

Adds an entry to scriptFields.

scriptFields

public final InnerHits.Builder scriptFields(String key,
 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
 Boolean value)

API name: seq_no_primary_term

fields

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

API name: fields

Adds all elements of list to fields.

fields

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

API name: fields

Adds one or more values to fields.

sort

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

How the inner hits should be sorted per inner_hits. By default, inner hits are sorted by score.

API name: sort

Adds all elements of list to sort.

sort

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

How the inner hits should be sorted per inner_hits. By default, inner hits are sorted by score.

API name: sort

Adds one or more values to sort.

sort

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

How the inner hits should be sorted per inner_hits. By default, inner hits are sorted by score.

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(Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)

API name: _source

storedFields

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

API name: stored_fields

Adds all elements of list to storedFields.

storedFields

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

API name: stored_fields

Adds one or more values to storedFields.

trackScores

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

API name: track_scores

version

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

API name: version

self

protected InnerHits.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<InnerHits.Builder>

build

public InnerHits build()

Builds a InnerHits.

Specified by:

build in interface ObjectBuilder<InnerHits>

Throws:

NullPointerException - if some of the required fields are null.