Package co.elastic.clients.elasticsearch.async_search.status

Class StatusResponseBase

java.lang.Object

co.elastic.clients.elasticsearch.async_search.AsyncSearchResponseBase

co.elastic.clients.elasticsearch.async_search.status.StatusResponseBase

All Implemented Interfaces:

JsonpSerializable

Direct Known Subclasses:

AsyncSearchStatusResponse

public abstract class StatusResponseBase
extends AsyncSearchResponseBase

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StatusResponseBase.AbstractBuilder<BuilderT extends StatusResponseBase.AbstractBuilder<BuilderT>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StatusResponseBase(StatusResponseBase.AbstractBuilder<?> builder)

Method Summary

Modifier and Type	Method	Description
final ClusterStatistics	clusters()	Metadata about clusters involved in the cross-cluster search.
final Integer	completionStatus()	If the async search completed, this field shows the status code of the search.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <BuilderT extends StatusResponseBase.AbstractBuilder<BuilderT>> void	setupStatusResponseBaseDeserializer(ObjectDeserializer<BuilderT> op)
final ShardStatistics	shards()	Required - Indicates how many shards have run the query so far.

Methods inherited from class co.elastic.clients.elasticsearch.async_search.AsyncSearchResponseBase

completionTime, completionTimeInMillis, expirationTime, expirationTimeInMillis, id, isPartial, isRunning, serialize, setupAsyncSearchResponseBaseDeserializer, startTime, startTimeInMillis, toString

Methods inherited from class java.lang.Object

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

Constructor Details

StatusResponseBase

protected StatusResponseBase(StatusResponseBase.AbstractBuilder<?> builder)

Method Details

shards

public final ShardStatistics shards()

Required - Indicates how many shards have run the query so far.

API name: _shards

clusters

@Nullable
public final ClusterStatistics clusters()

Metadata about clusters involved in the cross-cluster search. Not shown for local-only searches.

API name: _clusters

completionStatus

@Nullable
public final Integer completionStatus()

If the async search completed, this field shows the status code of the search. For example, 200 indicates that the async search was successfully completed. 503 indicates that the async search was completed with an error.

API name: completion_status

serializeInternal

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

Overrides:

serializeInternal in class AsyncSearchResponseBase

setupStatusResponseBaseDeserializer

protected static <BuilderT extends StatusResponseBase.AbstractBuilder<BuilderT>>
void setupStatusResponseBaseDeserializer(ObjectDeserializer<BuilderT> op)