Class GetAsyncResponse
java.lang.Object
co.elastic.clients.elasticsearch.sql.GetAsyncResponse
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class GetAsyncResponse extends java.lang.Object implements JsonpSerializable
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetAsyncResponse.Builder
Builder forGetAsyncResponse
. -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<GetAsyncResponse>
_DESERIALIZER
Json deserializer forGetAsyncResponse
-
Method Summary
Modifier and Type Method Description java.util.List<Column>
columns()
Column headings for the search results.java.lang.String
cursor()
Cursor for the next set of paginated results.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 GetAsyncResponse
of(java.util.function.Function<GetAsyncResponse.Builder,ObjectBuilder<GetAsyncResponse>> fn)
java.util.List<java.util.List<JsonData>>
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
setupGetAsyncResponseDeserializer(ObjectDeserializer<GetAsyncResponse.Builder> op)
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 forGetAsyncResponse
-
-
Method Details
-
of
public static GetAsyncResponse of(java.util.function.Function<GetAsyncResponse.Builder,ObjectBuilder<GetAsyncResponse>> fn) -
id
public final java.lang.String 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
@Nullable public final java.lang.String 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
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
setupGetAsyncResponseDeserializer
protected static void setupGetAsyncResponseDeserializer(ObjectDeserializer<GetAsyncResponse.Builder> op)
-