GetAsyncRequest (java-client 8.1.3 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.sql.GetAsyncRequest

public class GetAsyncRequest
extends RequestBase

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

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 Endpoint<GetAsyncRequest,GetAsyncResponse,ErrorResponse> _ENDPOINT
Endpoint "sql.get_async".

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`delimiter()`	Separator for CSV results.
`java.lang.String`	`format()`	Format for the response.
`java.lang.String`	`id()`	Required - The async search ID
`Time`	`keepAlive()`	Retention period for the search and its results.
`static GetAsyncRequest`	`of(java.util.function.Function<GetAsyncRequest.Builder,ObjectBuilder<GetAsyncRequest>> fn)`
`Time`	`waitForCompletionTimeout()`	Period to wait for complete results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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(java.util.function.Function<GetAsyncRequest.Builder,ObjectBuilder<GetAsyncRequest>> fn)
- delimiter
  
  @Nullable public final java.lang.String delimiter()
  
  Separator for CSV results. The API only supports this parameter for CSV responses.
  API name: delimiter
- format
  
  @Nullable public final java.lang.String 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
  
  public final java.lang.String id()
  
  Required - The async search ID
  API name: id
- keepAlive
  
  @Nullable public final Time keepAlive()
  
  Retention period for the search and its results. Defaults to the keep_alive period for the original SQL search.
  API name: keep_alive
- waitForCompletionTimeout
  
  @Nullable public final Time 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