Class GetAsyncRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.sql.GetAsyncRequest
Returns the current status and available results for an async SQL search or
stored synchronous SQL search
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<GetAsyncRequest,
GetAsyncResponse, ErrorResponse> Endpoint "sql.get_async
". -
Method Summary
Modifier and TypeMethodDescriptionfinal String
Separator for CSV results.final String
format()
Format for the response.final String
id()
Required - The async search IDfinal Time
Retention period for the search and its results.static GetAsyncRequest
final Time
Period to wait for complete results.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "sql.get_async
".
-
-
Method Details
-
of
public static GetAsyncRequest of(Function<GetAsyncRequest.Builder, ObjectBuilder<GetAsyncRequest>> fn) -
delimiter
Separator for CSV results. The API only supports this parameter for CSV responses.API name:
delimiter
-
format
Format for the response. You must specify a format using this parameter or the Accept HTTP header. If you specify both, the API uses this parameter.API name:
format
-
id
Required - The async search IDAPI name:
id
-
keepAlive
Retention period for the search and its results. Defaults to thekeep_alive
period for the original SQL search.API name:
keep_alive
-
waitForCompletionTimeout
Period to wait for complete results. Defaults to no timeout, meaning the request waits for complete search results.API name:
wait_for_completion_timeout
-