Class GetAsyncResponse
java.lang.Object
co.elastic.clients.elasticsearch.sql.GetAsyncResponse
- All Implemented Interfaces:
JsonpSerializable
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<GetAsyncResponse>
Json deserializer forGetAsyncResponse
-
Method Summary
Modifier and TypeMethodDescriptioncolumns()
Column headings for the search results.final String
cursor()
Cursor for the next set of paginated results.final String
id()
Required - Identifier for the search.final boolean
Required - Iftrue
, the response does not contain complete search results.final boolean
Required - Iftrue
, the search is still running.static GetAsyncResponse
rows()
Required - Values for the search results.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
toString()
-
Field Details
-
_DESERIALIZER
Json deserializer forGetAsyncResponse
-
-
Method Details
-
of
public static GetAsyncResponse of(Function<GetAsyncResponse.Builder, ObjectBuilder<GetAsyncResponse>> fn) -
id
Required - Identifier for the search. This value is only returned for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in theAsync-ID
HTTP header.API name:
id
-
isRunning
public final boolean isRunning()Required - Iftrue
, the search is still running. If false, the search has finished. This value is only returned for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in theAsync-partial
HTTP header.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. This value is only returned for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in theAsync-partial
HTTP header.API name:
is_partial
-
columns
Column headings for the search results. Each object is a column.API name:
columns
-
cursor
Cursor for the next set of paginated results. For CSV, TSV, and TXT responses, this value is returned in theCursor
HTTP header.API name:
cursor
-
rows
Required - Values for the search results.API name:
rows
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
-
setupGetAsyncResponseDeserializer
protected static void setupGetAsyncResponseDeserializer(ObjectDeserializer<GetAsyncResponse.Builder> op)
-