Package co.elastic.clients.elasticsearch.sql

Class GetAsyncStatusResponse

java.lang.Object

co.elastic.clients.elasticsearch.sql.GetAsyncStatusResponse

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class GetAsyncStatusResponse
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetAsyncStatusResponse.Builder	Builder for GetAsyncStatusResponse.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<GetAsyncStatusResponse>	_DESERIALIZER	Json deserializer for GetAsyncStatusResponse

Method Summary

Modifier and Type	Method	Description
final Number	completionStatus()	The HTTP status code for the search.
final long	expirationTimeInMillis()	Required - The timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete the search and its results, even if the search is still running.
final String	id()	Required - The identifier for the search.
final boolean	isPartial()	Required - If true, the response does not contain complete search results.
final boolean	isRunning()	Required - If true, the search is still running.
static GetAsyncStatusResponse	of(Function<GetAsyncStatusResponse.Builder,ObjectBuilder<GetAsyncStatusResponse>> 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 void	setupGetAsyncStatusResponseDeserializer(ObjectDeserializer<GetAsyncStatusResponse.Builder> op)
final long	startTimeInMillis()	Required - The timestamp, in milliseconds since the Unix epoch, when the search started.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<GetAsyncStatusResponse> _DESERIALIZER

Json deserializer for GetAsyncStatusResponse

Method Details

of

public static GetAsyncStatusResponse of(Function<GetAsyncStatusResponse.Builder,ObjectBuilder<GetAsyncStatusResponse>> fn)

expirationTimeInMillis

public final long expirationTimeInMillis()

Required - The timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete the search and its results, even if the search is still running.

API name: expiration_time_in_millis

id

public final String id()

Required - The identifier for the search.

API name: id

isRunning

public final boolean isRunning()

Required - If true, the search is still running. If false, the search has finished.

API name: is_running

isPartial

public final boolean isPartial()

Required - If true, the response does not contain complete search results. If is_partial is true and is_running is true, the search is still running. If is_partial is true but is_running is false, the results are partial due to a failure or timeout.

API name: is_partial

startTimeInMillis

public final long startTimeInMillis()

Required - The timestamp, in milliseconds since the Unix epoch, when the search started. The API returns this property only for running searches.

API name: start_time_in_millis

completionStatus

@Nullable
public final Number completionStatus()

The HTTP status code for the search. The API returns this property only for completed searches.

API name: completion_status

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)

toString

public String toString()

Overrides:

toString in class Object

setupGetAsyncStatusResponseDeserializer

protected static void setupGetAsyncStatusResponseDeserializer(ObjectDeserializer<GetAsyncStatusResponse.Builder> op)