Files
elasticsearch-js/docs/reference/api/SqlGetAsyncRequest.md
2025-05-28 10:02:30 -05:00

1.2 KiB

SqlGetAsyncRequest [interface-SqlGetAsyncRequest]

Name Type Description
body string ({ [key: string]: any; } & { id?: never; delimiter?: never; format?: never; keep_alive?: never; wait_for_completion_timeout?: never; })
delimiter string The separator for CSV results. The API supports this parameter only for CSV responses.
format string 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.
id Id The identifier for the search.
keep_alive Duration The retention period for the search and its results. It defaults to the keep_alive period for the original SQL search.
querystring { [key: string]: any; } & { id?: never; delimiter?: never; format?: 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 complete results. It defaults to no timeout, meaning the request waits for complete search results.