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

Class Hit.Builder<TDocument>

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.Hit.Builder<TDocument>

All Implemented Interfaces:

ObjectBuilder<Hit<TDocument>>

Enclosing class:

Hit<TDocument>

public static class Hit.Builder<TDocument>
extends ObjectBuilderBase
implements ObjectBuilder<Hit<TDocument>>

Builder for Hit.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Hit<TDocument>	build()	Builds a Hit.
Hit.Builder<TDocument>	explanation(java.util.function.Function<Explanation.Builder,ObjectBuilder<Explanation>> fn)	API name: _explanation
Hit.Builder<TDocument>	explanation(Explanation value)	API name: _explanation
Hit.Builder<TDocument>	fields(java.lang.String key, JsonData value)	API name: fields
Hit.Builder<TDocument>	fields(java.util.Map<java.lang.String,JsonData> map)	API name: fields
Hit.Builder<TDocument>	highlight(java.lang.String key, java.util.List<java.lang.String> value)	API name: highlight
Hit.Builder<TDocument>	highlight(java.util.Map<java.lang.String,java.util.List<java.lang.String>> map)	API name: highlight
Hit.Builder<TDocument>	id(java.lang.String value)	API name: _id
Hit.Builder<TDocument>	ignored(java.lang.String value, java.lang.String... values)	API name: _ignored
Hit.Builder<TDocument>	ignored(java.util.List<java.lang.String> list)	API name: _ignored
Hit.Builder<TDocument>	index(java.lang.String value)	Required - API name: _index
Hit.Builder<TDocument>	innerHits(java.lang.String key, java.util.function.Function<InnerHitsResult.Builder,ObjectBuilder<InnerHitsResult>> fn)	API name: inner_hits
Hit.Builder<TDocument>	innerHits(java.lang.String key, InnerHitsResult value)	API name: inner_hits
Hit.Builder<TDocument>	innerHits(java.util.Map<java.lang.String,InnerHitsResult> map)	API name: inner_hits
Hit.Builder<TDocument>	matchedQueries(java.lang.String value, java.lang.String... values)	API name: matched_queries
Hit.Builder<TDocument>	matchedQueries(java.util.List<java.lang.String> list)	API name: matched_queries
Hit.Builder<TDocument>	nested(java.util.function.Function<NestedIdentity.Builder,ObjectBuilder<NestedIdentity>> fn)	API name: _nested
Hit.Builder<TDocument>	nested(NestedIdentity value)	API name: _nested
Hit.Builder<TDocument>	node(java.lang.String value)	API name: _node
Hit.Builder<TDocument>	primaryTerm(java.lang.Long value)	API name: _primary_term
Hit.Builder<TDocument>	routing(java.lang.String value)	API name: _routing
Hit.Builder<TDocument>	score(java.lang.Double value)	API name: _score
Hit.Builder<TDocument>	seqNo(java.lang.Long value)	API name: _seq_no
Hit.Builder<TDocument>	shard(java.lang.String value)	API name: _shard
Hit.Builder<TDocument>	sort(java.lang.String value, java.lang.String... values)	API name: sort
Hit.Builder<TDocument>	sort(java.util.List<java.lang.String> list)	API name: sort
Hit.Builder<TDocument>	sortVals(java.util.List<FieldValue> list)	API name: sort
Hit.Builder<TDocument>	sortVals(FieldValue value, FieldValue... values)	API name: sort
Hit.Builder<TDocument>	source(TDocument value)	API name: _source
Hit.Builder<TDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
Hit.Builder<TDocument>	version(java.lang.Long 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

index

public final Hit.Builder<TDocument> index(@Nullable
                                          java.lang.String value)

Required - API name: _index

id

public final Hit.Builder<TDocument> id(@Nullable
                                       java.lang.String value)

API name: _id

score

public final Hit.Builder<TDocument> score(@Nullable
                                          java.lang.Double value)

API name: _score

explanation

public final Hit.Builder<TDocument> explanation(@Nullable
                                                Explanation value)

API name: _explanation

explanation

public final Hit.Builder<TDocument> explanation(java.util.function.Function<Explanation.Builder,ObjectBuilder<Explanation>> fn)

API name: _explanation

fields

public final Hit.Builder<TDocument> fields(java.util.Map<java.lang.String,JsonData> map)

API name: fields

Adds all entries of map to fields.

fields

public final Hit.Builder<TDocument> fields(java.lang.String key,
                                           JsonData value)

API name: fields

Adds an entry to fields.

highlight

public final Hit.Builder<TDocument> highlight(java.util.Map<java.lang.String,java.util.List<java.lang.String>> map)

API name: highlight

Adds all entries of map to highlight.

highlight

public final Hit.Builder<TDocument> highlight(java.lang.String key,
                                              java.util.List<java.lang.String> value)

API name: highlight

Adds an entry to highlight.

innerHits

public final Hit.Builder<TDocument> innerHits(java.util.Map<java.lang.String,InnerHitsResult> map)

API name: inner_hits

Adds all entries of map to innerHits.

innerHits

public final Hit.Builder<TDocument> innerHits(java.lang.String key,
                                              InnerHitsResult value)

API name: inner_hits

Adds an entry to innerHits.

innerHits

public final Hit.Builder<TDocument> innerHits(java.lang.String key,
                                              java.util.function.Function<InnerHitsResult.Builder,ObjectBuilder<InnerHitsResult>> fn)

API name: inner_hits

Adds an entry to innerHits using a builder lambda.

matchedQueries

public final Hit.Builder<TDocument> matchedQueries(java.util.List<java.lang.String> list)

API name: matched_queries

Adds all elements of list to matchedQueries.

matchedQueries

public final Hit.Builder<TDocument> matchedQueries(java.lang.String value,
                                                   java.lang.String... values)

API name: matched_queries

Adds one or more values to matchedQueries.

nested

public final Hit.Builder<TDocument> nested(@Nullable
                                           NestedIdentity value)

API name: _nested

nested

public final Hit.Builder<TDocument> nested(java.util.function.Function<NestedIdentity.Builder,ObjectBuilder<NestedIdentity>> fn)

API name: _nested

ignored

public final Hit.Builder<TDocument> ignored(java.util.List<java.lang.String> list)

API name: _ignored

Adds all elements of list to ignored.

ignored

public final Hit.Builder<TDocument> ignored(java.lang.String value,
                                            java.lang.String... values)

API name: _ignored

Adds one or more values to ignored.

shard

public final Hit.Builder<TDocument> shard(@Nullable
                                          java.lang.String value)

API name: _shard

node

public final Hit.Builder<TDocument> node(@Nullable
                                         java.lang.String value)

API name: _node

routing

public final Hit.Builder<TDocument> routing(@Nullable
                                            java.lang.String value)

API name: _routing

source

public final Hit.Builder<TDocument> source(@Nullable
                                           TDocument value)

API name: _source

seqNo

public final Hit.Builder<TDocument> seqNo(@Nullable
                                          java.lang.Long value)

API name: _seq_no

primaryTerm

public final Hit.Builder<TDocument> primaryTerm(@Nullable
                                                java.lang.Long value)

API name: _primary_term

version

public final Hit.Builder<TDocument> version(@Nullable
                                            java.lang.Long value)

API name: _version

sort

public final Hit.Builder<TDocument> sort(java.util.List<java.lang.String> list)

API name: sort

Adds all elements of list to sort.

NOTE: In version 3.0.0 of opensearch-java, this method will instead accept a List<FieldValue>.

sort

public final Hit.Builder<TDocument> sort(java.lang.String value,
                                         java.lang.String... values)

API name: sort

Adds one or more values to sort.

NOTE: In version 3.0.0 of opensearch-java, this method will instead accept a List<FieldValue>.

sortVals

public final Hit.Builder<TDocument> sortVals(java.util.List<FieldValue> list)

API name: sort

Adds all elements of list to sort.

NOTE: In version 3.0.0 of opensearch-java, this method will be renamed to replace sort(List).

sortVals

public final Hit.Builder<TDocument> sortVals(FieldValue value,
                                             FieldValue... values)

API name: sort

Adds one or more values to sort.

NOTE: In version 3.0.0 of opensearch-java, this method will be renamed to replace sort(String, String...).

tDocumentSerializer

public final Hit.Builder<TDocument> tDocumentSerializer(@Nullable
                                                        JsonpSerializer<TDocument> value)

Serializer for TDocument. If not set, an attempt will be made to find a serializer from the JSON context.

build

public Hit<TDocument> build()

Builds a Hit.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

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