Files
elasticsearch-js/docs/reference/api/EsqlAsyncQueryGetRequest.md
2025-05-27 15:30:21 -05:00

1.6 KiB

Interface EsqlAsyncQueryGetRequest

Name Type Description
body string ({ [key: string]: any; } & { id?: never; drop_null_columns?: never; keep_alive?: never; wait_for_completion_timeout?: never; })
drop_null_columns boolean Indicates whether columns that are entirely null will be removed from the columns and values portion of the results. If true, the response will include an extra section under the name all_columns which has the name of all the columns.
id Id The unique identifier of the query. A query ID is provided in the ES
keep_alive Duration The period for which the query and its results are stored in the cluster. When this period expires, the query and its results are deleted, even if the query is still ongoing.
querystring { [key: string]: any; } & { id?: never; drop_null_columns?: never; keep_alive?: never; wait_for_completion_timeout?: never; } All values in querystring will be added to the request querystring.
wait_for_completion_timeout Duration The period to wait for the request to finish. By default, the request waits for complete query results. If the request completes during the period specified in this parameter, complete query results are returned. Otherwise, the response returns an is_running value of true and no results.