Class GetAsyncStatusResponse
java.lang.Object
co.elastic.clients.elasticsearch.sql.GetAsyncStatusResponse
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class GetAsyncStatusResponse extends java.lang.Object implements JsonpSerializable
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetAsyncStatusResponse.Builder
Builder forGetAsyncStatusResponse
. -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<GetAsyncStatusResponse>
_DESERIALIZER
Json deserializer forGetAsyncStatusResponse
-
Method Summary
Modifier and Type Method Description java.lang.Number
completionStatus()
HTTP status code for the search.java.lang.Number
expirationTimeInMillis()
Required - Timestamp, in milliseconds since the Unix epoch, when Elasticsearch will delete the search and its results, even if the search is still running.java.lang.String
id()
Required - Identifier for the search.boolean
isPartial()
Required - Iftrue
, the response does not contain complete search results.boolean
isRunning()
Required - Iftrue
, the search is still running.static GetAsyncStatusResponse
of(java.util.function.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)
java.lang.Number
startTimeInMillis()
Required - Timestamp, in milliseconds since the Unix epoch, when the search started.java.lang.String
toString()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forGetAsyncStatusResponse
-
-
Method Details
-
of
public static GetAsyncStatusResponse of(java.util.function.Function<GetAsyncStatusResponse.Builder,ObjectBuilder<GetAsyncStatusResponse>> fn) -
id
public final java.lang.String id()Required - Identifier for the search.API name:
id
-
isRunning
public final boolean isRunning()Required - Iftrue
, the search is still running. Iffalse
, the search has finished.API name:
is_running
-
isPartial
public final boolean isPartial()Required - Iftrue
, the response does not contain complete search results. Ifis_partial
istrue
andis_running
istrue
, the search is still running. Ifis_partial
istrue
butis_running
isfalse
, the results are partial due to a failure or timeout.API name:
is_partial
-
startTimeInMillis
public final java.lang.Number startTimeInMillis()Required - Timestamp, in milliseconds since the Unix epoch, when the search started. The API only returns this property for running searches.API name:
start_time_in_millis
-
expirationTimeInMillis
public final java.lang.Number expirationTimeInMillis()Required - 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
-
completionStatus
@Nullable public final java.lang.Number completionStatus()HTTP status code for the search. The API only returns this property for completed searches.API name:
completion_status
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
setupGetAsyncStatusResponseDeserializer
protected static void setupGetAsyncStatusResponseDeserializer(ObjectDeserializer<GetAsyncStatusResponse.Builder> op)
-