Package co.elastic.clients.elasticsearch.sql

Class GetAsyncRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.sql.GetAsyncRequest

public class GetAsyncRequest
extends RequestBase

Get async SQL search results. Get the current status and available results for an async SQL search or stored synchronous SQL search.

If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<GetAsyncRequest,GetAsyncResponse,ErrorResponse>	_ENDPOINT	Endpoint "sql.get_async".

Method Summary

Modifier and Type	Method	Description
final String	delimiter()	The separator for CSV results.
final String	format()	The format for the response.
final String	id()	Required - The identifier for the search.
final Time	keepAlive()	The retention period for the search and its results.
static GetAsyncRequest	of(Function<GetAsyncRequest.Builder,ObjectBuilder<GetAsyncRequest>> fn)
final Time	waitForCompletionTimeout()	The period to wait for complete results.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

public static final Endpoint<GetAsyncRequest,GetAsyncResponse,ErrorResponse> _ENDPOINT

Endpoint "sql.get_async".

Method Details

of

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

delimiter

@Nullable
public final String delimiter()

The separator for CSV results. The API supports this parameter only for CSV responses.

API name: delimiter

format

@Nullable
public final String format()

The 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

public final String id()

Required - The identifier for the search.

API name: id

keepAlive

@Nullable
public final Time keepAlive()

The retention period for the search and its results. It defaults to the keep_alive period for the original SQL search.

API name: keep_alive

waitForCompletionTimeout

@Nullable
public final Time waitForCompletionTimeout()

The period to wait for complete results. It defaults to no timeout, meaning the request waits for complete search results.

API name: wait_for_completion_timeout