Package org.opensearch.client.opensearch._global.mget

Class Hit.Builder<TDocument>

java.lang.Object

org.opensearch.client.opensearch._global.mget.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<TDocument>	build()	Builds a Hit.
Hit.Builder<TDocument>	error(java.util.function.Function<MainError.Builder,ObjectBuilder<MainError>> fn)	API name: error
Hit.Builder<TDocument>	error(MainError value)	API name: error
Hit.Builder<TDocument>	fields(java.util.Map<java.lang.String,jakarta.json.JsonValue> value)	API name: fields
Hit.Builder<TDocument>	found(java.lang.Boolean value)	API name: found
Hit.Builder<TDocument>	id(java.lang.String value)	API name: _id
Hit.Builder<TDocument>	index(java.lang.String value)	API name: _index
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>	routing(jakarta.json.JsonValue value)	API name: _routing
Hit.Builder<TDocument>	seqNo(java.lang.Number value)	API name: _seq_no
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

error

public Hit.Builder<TDocument> error(@Nullable MainError value)

API name: error

error

public Hit.Builder<TDocument> error(java.util.function.Function<MainError.Builder,ObjectBuilder<MainError>> fn)

API name: error

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.

found

public Hit.Builder<TDocument> found(@Nullable java.lang.Boolean value)

API name: found

id

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

API name: _id

index

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

API name: _index

primaryTerm

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

API name: _primary_term

routing

public Hit.Builder<TDocument> routing(@Nullable jakarta.json.JsonValue value)

API name: _routing

seqNo

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

API name: _seq_no

source

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

API name: _source

type

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

API name: _type

version

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

API name: _version

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.