Package org.opensearch.client.opensearch.core

Class SearchTemplateResponse<TDocument>

java.lang.Object

org.opensearch.client.opensearch.core.SearchTemplateResponse<TDocument>

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class SearchTemplateResponse<TDocument>
extends java.lang.Object
implements JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchTemplateResponse.Builder<TDocument>	Builder for SearchTemplateResponse.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<SearchTemplateResponse<java.lang.Object>>	_DESERIALIZER	Json deserializer for SearchTemplateResponse based on named deserializers provided by the calling JsonMapper.

Method Summary

Modifier and Type	Method	Description
static <TDocument> JsonpDeserializer<SearchTemplateResponse<TDocument>>	createSearchTemplateResponseDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create a JSON deserializer for SearchTemplateResponse
HitsMetadata<TDocument>	hits()	Required - API name: hits
static <TDocument> SearchTemplateResponse<TDocument>	of(java.util.function.Function<SearchTemplateResponse.Builder<TDocument>,ObjectBuilder<SearchTemplateResponse<TDocument>>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <TDocument> void	setupSearchTemplateResponseDeserializer(ObjectDeserializer<SearchTemplateResponse.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)
ShardStatistics	shards()	Required - API name: _shards
boolean	timedOut()	Required - API name: timed_out
int	took()	Required - API name: took

Methods inherited from class java.lang.Object

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<SearchTemplateResponse<java.lang.Object>> _DESERIALIZER

Json deserializer for SearchTemplateResponse based on named deserializers provided by the calling JsonMapper.

Method Detail

of

public static <TDocument> SearchTemplateResponse<TDocument> of(java.util.function.Function<SearchTemplateResponse.Builder<TDocument>,ObjectBuilder<SearchTemplateResponse<TDocument>>> fn)

shards

public final ShardStatistics shards()

Required - API name: _shards

timedOut

public final boolean timedOut()

Required - API name: timed_out

took

public final int took()

Required - API name: took

hits

public final HitsMetadata<TDocument> hits()

Required - API name: hits

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

createSearchTemplateResponseDeserializer

public static <TDocument> JsonpDeserializer<SearchTemplateResponse<TDocument>> createSearchTemplateResponseDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create a JSON deserializer for SearchTemplateResponse

setupSearchTemplateResponseDeserializer

protected static <TDocument> void setupSearchTemplateResponseDeserializer(ObjectDeserializer<SearchTemplateResponse.Builder<TDocument>> op,
                                                                          JsonpDeserializer<TDocument> tDocumentDeserializer)