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

Class Hit.Builder<TDocument>

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<Hit.Builder<TDocument>>

co.elastic.clients.elasticsearch.core.search.Hit.Builder<TDocument>

All Implemented Interfaces:

WithJson<Hit.Builder<TDocument>>, ObjectBuilder<Hit<TDocument>>

Enclosing class:

Hit<TDocument>

public static class Hit.Builder<TDocument>
extends WithJsonObjectBuilderBase<Hit.Builder<TDocument>>
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.
final Hit.Builder<TDocument>	explanation(Explanation value)	API name: _explanation
final Hit.Builder<TDocument>	explanation(Function<Explanation.Builder,ObjectBuilder<Explanation>> fn)	API name: _explanation
final Hit.Builder<TDocument>	fields(String key, JsonData value)	API name: fields
final Hit.Builder<TDocument>	fields(Map<String,JsonData> map)	API name: fields
final Hit.Builder<TDocument>	highlight(String key, List<String> value)	API name: highlight
final Hit.Builder<TDocument>	highlight(Map<String,List<String>> map)	API name: highlight
final Hit.Builder<TDocument>	id(String value)	API name: _id
final Hit.Builder<TDocument>	ignored(String value, String... values)	API name: _ignored
final Hit.Builder<TDocument>	ignored(List<String> list)	API name: _ignored
final Hit.Builder<TDocument>	ignoredFieldValues(String key, List<JsonData> value)	API name: ignored_field_values
final Hit.Builder<TDocument>	ignoredFieldValues(Map<String,List<JsonData>> map)	API name: ignored_field_values
final Hit.Builder<TDocument>	index(String value)	Required - API name: _index
final Hit.Builder<TDocument>	innerHits(String key, InnerHitsResult value)	API name: inner_hits
final Hit.Builder<TDocument>	innerHits(String key, Function<InnerHitsResult.Builder,ObjectBuilder<InnerHitsResult>> fn)	API name: inner_hits
final Hit.Builder<TDocument>	innerHits(Map<String,InnerHitsResult> map)	API name: inner_hits
final Hit.Builder<TDocument>	matchedQueries(String key, Double value)	API name: matched_queries
final Hit.Builder<TDocument>	matchedQueries(Map<String,Double> map)	API name: matched_queries
final Hit.Builder<TDocument>	nested(NestedIdentity value)	API name: _nested
final Hit.Builder<TDocument>	nested(Function<NestedIdentity.Builder,ObjectBuilder<NestedIdentity>> fn)	API name: _nested
final Hit.Builder<TDocument>	node(String value)	API name: _node
final Hit.Builder<TDocument>	primaryTerm(Long value)	API name: _primary_term
final Hit.Builder<TDocument>	rank(Integer value)	API name: _rank
final Hit.Builder<TDocument>	routing(String value)	API name: _routing
final Hit.Builder<TDocument>	score(Double value)	API name: _score
protected Hit.Builder<TDocument>	self()
final Hit.Builder<TDocument>	seqNo(Long value)	API name: _seq_no
final Hit.Builder<TDocument>	shard(String value)	API name: _shard
final Hit.Builder<TDocument>	sort(boolean value, boolean... values)	API name: sort
final Hit.Builder<TDocument>	sort(double value, double... values)	API name: sort
final Hit.Builder<TDocument>	sort(long value, long... values)	API name: sort
final Hit.Builder<TDocument>	sort(FieldValue value, FieldValue... values)	API name: sort
final Hit.Builder<TDocument>	sort(String value, String... values)	API name: sort
final Hit.Builder<TDocument>	sort(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	API name: sort
final Hit.Builder<TDocument>	sort(List<FieldValue> list)	API name: sort
final Hit.Builder<TDocument>	source(TDocument value)	API name: _source
final Hit.Builder<TDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
final Hit.Builder<TDocument>	version(Long 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

index

public final Hit.Builder<TDocument> index(String value)

Required - API name: _index

id

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

API name: _id

score

public final Hit.Builder<TDocument> score(@Nullable
 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(Function<Explanation.Builder,ObjectBuilder<Explanation>> fn)

API name: _explanation

fields

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

API name: fields

Adds all entries of map to fields.

fields

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

API name: fields

Adds an entry to fields.

highlight

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

API name: highlight

Adds all entries of map to highlight.

highlight

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

API name: highlight

Adds an entry to highlight.

innerHits

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

API name: inner_hits

Adds all entries of map to innerHits.

innerHits

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

API name: inner_hits

Adds an entry to innerHits.

innerHits

public final Hit.Builder<TDocument> innerHits(String key,
 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(Map<String,Double> map)

API name: matched_queries

Adds all entries of map to matchedQueries.

matchedQueries

public final Hit.Builder<TDocument> matchedQueries(String key,
 Double value)

API name: matched_queries

Adds an entry to matchedQueries.

nested

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

API name: _nested

nested

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

API name: _nested

ignored

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

API name: _ignored

Adds all elements of list to ignored.

ignored

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

API name: _ignored

Adds one or more values to ignored.

ignoredFieldValues

public final Hit.Builder<TDocument> ignoredFieldValues(Map<String,List<JsonData>> map)

API name: ignored_field_values

Adds all entries of map to ignoredFieldValues.

ignoredFieldValues

public final Hit.Builder<TDocument> ignoredFieldValues(String key,
 List<JsonData> value)

API name: ignored_field_values

Adds an entry to ignoredFieldValues.

shard

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

API name: _shard

node

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

API name: _node

routing

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

API name: _routing

source

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

API name: _source

rank

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

API name: _rank

seqNo

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

API name: _seq_no

primaryTerm

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

API name: _primary_term

version

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

API name: _version

sort

public final Hit.Builder<TDocument> sort(List<FieldValue> list)

API name: sort

Adds all elements of list to sort.

sort

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

API name: sort

Adds one or more values to sort.

sort

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

API name: sort

Adds one or more values to sort.

sort

public final Hit.Builder<TDocument> sort(long value,
 long... values)

API name: sort

Adds one or more values to sort.

sort

public final Hit.Builder<TDocument> sort(double value,
 double... values)

API name: sort

Adds one or more values to sort.

sort

public final Hit.Builder<TDocument> sort(boolean value,
 boolean... values)

API name: sort

Adds one or more values to sort.

sort

public final Hit.Builder<TDocument> sort(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)

API name: sort

Adds a value to sort using a builder lambda.

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.

self

protected Hit.Builder<TDocument> self()

Specified by:

self in class WithJsonObjectBuilderBase<Hit.Builder<TDocument>>

build

public Hit<TDocument> build()

Builds a Hit.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

NullPointerException - if some of the required fields are null.