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:

CopyableBuilder<Hit.Builder<TDocument>,Hit<TDocument>>, MutableBuilder<Hit.Builder<TDocument>,Hit<TDocument>>, ObjectBuilder<Hit<TDocument>>

Enclosing class:

Hit<TDocument>

public static class Hit.Builder<TDocument>
extends ObjectBuilderBase
implements CopyableBuilder<Hit.Builder<TDocument>,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>	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Hit.Builder<TDocument>	explanation(Function<Explanation.Builder,ObjectBuilder<Explanation>> fn)	API name: _explanation
final Hit.Builder<TDocument>	explanation(Explanation value)	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<String> value)	API name: ignored_field_values
final Hit.Builder<TDocument>	ignoredFieldValues(Map<String,List<String>> map)	API name: ignored_field_values
final Hit.Builder<TDocument>	index(String value)	API name: _index
final Hit.Builder<TDocument>	innerHits(String key, Function<InnerHitsResult.Builder,ObjectBuilder<InnerHitsResult>> fn)	API name: inner_hits
final Hit.Builder<TDocument>	innerHits(String key, InnerHitsResult value)	API name: inner_hits
final Hit.Builder<TDocument>	innerHits(Map<String,InnerHitsResult> map)	API name: inner_hits
final Hit.Builder<TDocument>	matchedQueries(String value, String... values)	API name: matched_queries
final Hit.Builder<TDocument>	matchedQueries(List<String> list)	API name: matched_queries
final Hit.Builder<TDocument>	nested(Function<NestedIdentity.Builder,ObjectBuilder<NestedIdentity>> fn)	API name: _nested
final Hit.Builder<TDocument>	nested(NestedIdentity value)	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>	routing(String value)	API name: _routing
final Hit.Builder<TDocument>	score(Double value)	API name: _score
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(Function<FieldValue.Builder,ObjectBuilder<FieldValue>> fn)	API name: sort
final Hit.Builder<TDocument>	sort(List<FieldValue> list)	API name: sort
final Hit.Builder<TDocument>	sort(FieldValue value, FieldValue... values)	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 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 Hit.Builder<TDocument> copy()

Description copied from interface: CopyableBuilder

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

Specified by:

copy in interface CopyableBuilder<Hit.Builder<TDocument>,Hit<TDocument>>

Returns:

a new builder instance.

explanation

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

API name: _explanation

explanation

@Nonnull
public final Hit.Builder<TDocument> explanation(Function<Explanation.Builder,ObjectBuilder<Explanation>> fn)

API name: _explanation

fields

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

API name: fields

Adds all elements of map to fields.

fields

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

API name: fields

Adds an entry to fields.

highlight

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

API name: highlight

Adds all elements of map to highlight.

highlight

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

API name: highlight

Adds an entry to highlight.

id

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

API name: _id

ignored

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

API name: _ignored

Adds all elements of list to ignored.

ignored

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

API name: _ignored

Adds one or more values to ignored.

ignoredFieldValues

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

API name: ignored_field_values

Adds all elements of map to ignoredFieldValues.

ignoredFieldValues

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

API name: ignored_field_values

Adds an entry to ignoredFieldValues.

index

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

API name: _index

innerHits

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

API name: inner_hits

Adds all elements of map to innerHits.

innerHits

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

API name: inner_hits

Adds an entry to innerHits.

innerHits

@Nonnull
public final Hit.Builder<TDocument> innerHits(String key,
 Function<InnerHitsResult.Builder,ObjectBuilder<InnerHitsResult>> fn)

API name: inner_hits

Adds a value to innerHits using a builder lambda.

matchedQueries

@Nonnull
public final Hit.Builder<TDocument> matchedQueries(List<String> list)

API name: matched_queries

Adds all elements of list to matchedQueries.

matchedQueries

@Nonnull
public final Hit.Builder<TDocument> matchedQueries(String value,
 String... values)

API name: matched_queries

Adds one or more values to matchedQueries.

nested

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

API name: _nested

nested

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

API name: _nested

node

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

API name: _node

primaryTerm

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

API name: _primary_term

routing

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

API name: _routing

score

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

API name: _score

seqNo

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

API name: _seq_no

shard

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

API name: _shard

sort

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

API name: sort

Adds all elements of list to sort.

sort

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

API name: sort

Adds one or more values to sort.

sort

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

API name: sort

Adds a value to sort using a builder lambda.

source

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

API name: _source

tDocumentSerializer

@Nonnull
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.

version

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

API name: _version

build

@Nonnull
public Hit<TDocument> build()

Builds a Hit.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

NullPointerException - if some of the required fields are null.