Package org.opensearch.client.opensearch._global

Class GetResponse.Builder<TDocument>

java.lang.Object

org.opensearch.client.opensearch._global.GetResponse.Builder<TDocument>

All Implemented Interfaces:

ObjectBuilder<GetResponse<TDocument>>

Enclosing class:

GetResponse<TDocument>

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

Builder for GetResponse.

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
GetResponse<TDocument>	build()	Builds a GetResponse.
GetResponse.Builder<TDocument>	fields(java.util.Map<java.lang.String,jakarta.json.JsonValue> value)	API name: fields
GetResponse.Builder<TDocument>	found(java.lang.Boolean value)	API name: found
GetResponse.Builder<TDocument>	id(java.lang.String value)	API name: _id
GetResponse.Builder<TDocument>	index(java.lang.String value)	API name: _index
GetResponse.Builder<TDocument>	primaryTerm(java.lang.Number value)	API name: _primary_term
GetResponse.Builder<TDocument>	putFields(java.lang.String key, jakarta.json.JsonValue value)	Add a key/value to fields(Map), creating the map if needed.
GetResponse.Builder<TDocument>	routing(java.lang.String value)	API name: _routing
GetResponse.Builder<TDocument>	seqNo(java.lang.Number value)	API name: _seq_no
GetResponse.Builder<TDocument>	source(TDocument value)	API name: _source
GetResponse.Builder<TDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
GetResponse.Builder<TDocument>	type(java.lang.String value)	deprecated since 7.0.0 API name: _type
GetResponse.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 GetResponse.Builder<TDocument> index(java.lang.String value)

API name: _index

fields

public GetResponse.Builder<TDocument> fields(@Nullable java.util.Map<java.lang.String,jakarta.json.JsonValue> value)

API name: fields

putFields

public GetResponse.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 GetResponse.Builder<TDocument> found(java.lang.Boolean value)

API name: found

id

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

API name: _id

primaryTerm

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

API name: _primary_term

routing

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

API name: _routing

seqNo

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

API name: _seq_no

source

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

API name: _source

type

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

deprecated since 7.0.0 API name: _type

version

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

API name: _version

tDocumentSerializer

public GetResponse.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 GetResponse<TDocument> build()

Builds a GetResponse.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

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