java.lang.Object

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

All Implemented Interfaces:: ObjectBuilder<Hit<TDocument>>

Enclosing class:: Hit<TDocument>

public static class Hit.Builder<TDocument>
extends java.lang.Object
implements ObjectBuilder<Hit<TDocument>>

Builder for Hit.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder
ObjectBuilder.Constant<V>
Constructor Summary

Constructors

Constructor Description

Builder()

Method Summary

Modifier and Type	Method	Description
`Hit.Builder<TDocument>`	`addIgnored(java.lang.String value)`	Add a value to `ignored(List)`, creating the list if needed.
`Hit.Builder<TDocument>`	`addMatchedQueries(java.lang.String value)`	Add a value to `matchedQueries(List)`, creating the list if needed.
`Hit.Builder<TDocument>`	`addSort(jakarta.json.JsonValue value)`	Add a value to `sort(List)`, creating the list if needed.
`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.util.Map<java.lang.String,jakarta.json.JsonValue> value)`	API name: `fields`
`Hit.Builder<TDocument>`	`highlight(java.util.Map<java.lang.String,java.util.List<java.lang.String>> value)`	API name: `highlight`
`Hit.Builder<TDocument>`	`id(java.lang.String value)`	API name: `_id`
`Hit.Builder<TDocument>`	`ignored(java.lang.String... value)`	API name: `_ignored`
`Hit.Builder<TDocument>`	`ignored(java.util.List<java.lang.String> value)`	API name: `_ignored`
`Hit.Builder<TDocument>`	`index(java.lang.String value)`	API name: `_index`
`Hit.Builder<TDocument>`	`innerHits(java.lang.String key, java.util.function.Function<InnerHitsResult.Builder,ObjectBuilder<InnerHitsResult>> fn)`	Set `innerHits(Map)` to a singleton map.
`Hit.Builder<TDocument>`	`innerHits(java.util.Map<java.lang.String,InnerHitsResult> value)`	API name: `inner_hits`
`Hit.Builder<TDocument>`	`matchedQueries(java.lang.String... value)`	API name: `matched_queries`
`Hit.Builder<TDocument>`	`matchedQueries(java.util.List<java.lang.String> value)`	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.Number value)`	API name: `_primary_term`
`Hit.Builder<TDocument>`	`putFields(java.lang.String key, jakarta.json.JsonValue value)`	Add a key/value to `fields(Map)`, creating the map if needed.
`Hit.Builder<TDocument>`	`putHighlight(java.lang.String key, java.util.List<java.lang.String> value)`	Add a key/value to `highlight(Map)`, creating the map if needed.
`Hit.Builder<TDocument>`	`putInnerHits(java.lang.String key, java.util.function.Function<InnerHitsResult.Builder,ObjectBuilder<InnerHitsResult>> fn)`	Add a key/value to `innerHits(Map)`, creating the map if needed.
`Hit.Builder<TDocument>`	`putInnerHits(java.lang.String key, InnerHitsResult value)`	Add a key/value to `innerHits(Map)`, creating the map if needed.
`Hit.Builder<TDocument>`	`routing(java.lang.String value)`	API name: `_routing`
`Hit.Builder<TDocument>`	`score(java.lang.Number value)`	API name: `_score`
`Hit.Builder<TDocument>`	`seqNo(java.lang.Number value)`	API name: `_seq_no`
`Hit.Builder<TDocument>`	`shard(java.lang.String value)`	API name: `_shard`
`Hit.Builder<TDocument>`	`sort(jakarta.json.JsonValue... value)`	API name: `sort`
`Hit.Builder<TDocument>`	`sort(java.util.List<jakarta.json.JsonValue> value)`	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>`	`type(java.lang.String value)`	API name: `_type`
`Hit.Builder<TDocument>`	`version(java.lang.Number value)`	API name: `_version`

Methods inherited from class java.lang.Object

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

Constructor Details
- Builder
  
  public Builder()
Method Details
- index
  
  public Hit.Builder<TDocument> index(java.lang.String value)
  
  API name: _index
- id
  
  public Hit.Builder<TDocument> id(java.lang.String value)
  
  API name: _id
- score
  
  public Hit.Builder<TDocument> score(@Nullable java.lang.Number value)
  
  API name: _score
- type
  
  public Hit.Builder<TDocument> type(@Nullable java.lang.String value)
  
  API name: _type
- explanation
  
  public Hit.Builder<TDocument> explanation(@Nullable Explanation value)
  
  API name: _explanation
- explanation
  
  public Hit.Builder<TDocument> explanation(java.util.function.Function<Explanation.Builder,ObjectBuilder<Explanation>> fn)
  
  API name: _explanation
- fields
  
  public Hit.Builder<TDocument> fields(@Nullable java.util.Map<java.lang.String,jakarta.json.JsonValue> value)
  
  API name: fields
- putFields
  
  public Hit.Builder<TDocument> putFields(java.lang.String key, jakarta.json.JsonValue value)
  
  Add a key/value to fields(Map), creating the map if needed.
- highlight
  
  public Hit.Builder<TDocument> highlight(@Nullable java.util.Map<java.lang.String,java.util.List<java.lang.String>> value)
  
  API name: highlight
- putHighlight
  
  public Hit.Builder<TDocument> putHighlight(java.lang.String key, java.util.List<java.lang.String> value)
  
  Add a key/value to highlight(Map), creating the map if needed.
- innerHits
  
  public Hit.Builder<TDocument> innerHits(@Nullable java.util.Map<java.lang.String,InnerHitsResult> value)
  
  API name: inner_hits
- putInnerHits
  
  public Hit.Builder<TDocument> putInnerHits(java.lang.String key, InnerHitsResult value)
  
  Add a key/value to innerHits(Map), creating the map if needed.
- innerHits
  
  public Hit.Builder<TDocument> innerHits(java.lang.String key, java.util.function.Function<InnerHitsResult.Builder,ObjectBuilder<InnerHitsResult>> fn)
  
  Set innerHits(Map) to a singleton map.
- putInnerHits
  
  public Hit.Builder<TDocument> putInnerHits(java.lang.String key, java.util.function.Function<InnerHitsResult.Builder,ObjectBuilder<InnerHitsResult>> fn)
  
  Add a key/value to innerHits(Map), creating the map if needed.
- matchedQueries
  
  public Hit.Builder<TDocument> matchedQueries(@Nullable java.util.List<java.lang.String> value)
  
  API name: matched_queries
- matchedQueries
  
  public Hit.Builder<TDocument> matchedQueries(java.lang.String... value)
  
  API name: matched_queries
- addMatchedQueries
  
  public Hit.Builder<TDocument> addMatchedQueries(java.lang.String value)
  
  Add a value to matchedQueries(List), creating the list if needed.
- nested
  
  public Hit.Builder<TDocument> nested(@Nullable NestedIdentity value)
  
  API name: _nested
- nested
  
  public Hit.Builder<TDocument> nested(java.util.function.Function<NestedIdentity.Builder,ObjectBuilder<NestedIdentity>> fn)
  
  API name: _nested
- ignored
  
  public Hit.Builder<TDocument> ignored(@Nullable java.util.List<java.lang.String> value)
  
  API name: _ignored
- ignored
  
  public Hit.Builder<TDocument> ignored(java.lang.String... value)
  
  API name: _ignored
- addIgnored
  
  public Hit.Builder<TDocument> addIgnored(java.lang.String value)
  
  Add a value to ignored(List), creating the list if needed.
- shard
  
  public Hit.Builder<TDocument> shard(@Nullable java.lang.String value)
  
  API name: _shard
- node
  
  public Hit.Builder<TDocument> node(@Nullable java.lang.String value)
  
  API name: _node
- routing
  
  public Hit.Builder<TDocument> routing(@Nullable java.lang.String value)
  
  API name: _routing
- source
  
  public Hit.Builder<TDocument> source(@Nullable TDocument value)
  
  API name: _source
- seqNo
  
  public Hit.Builder<TDocument> seqNo(@Nullable java.lang.Number value)
  
  API name: _seq_no
- primaryTerm
  
  public Hit.Builder<TDocument> primaryTerm(@Nullable java.lang.Number value)
  
  API name: _primary_term
- version
  
  public Hit.Builder<TDocument> version(@Nullable java.lang.Number value)
  
  API name: _version
- sort
  
  public Hit.Builder<TDocument> sort(@Nullable java.util.List<jakarta.json.JsonValue> value)
  
  API name: sort
- sort
  
  public Hit.Builder<TDocument> sort(jakarta.json.JsonValue... value)
  
  API name: sort
- addSort
  
  public Hit.Builder<TDocument> addSort(jakarta.json.JsonValue value)
  
  Add a value to sort(List), creating the list if needed.
- tDocumentSerializer
  
  public 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.

Class Hit.Builder<TDocument>

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Method Details