Struct elasticsearch::sql::SqlGetAsync

pub struct SqlGetAsync<'a, 'b> { /* private fields */ }

Builder for the Sql Get Async API

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

Implementations

impl<'a, 'b> SqlGetAsync<'a, 'b>

pub fn new(transport: &'a Transport, parts: SqlGetAsyncParts<'b>) -> Self

Creates a new instance of SqlGetAsync with the specified API parts

pub fn delimiter(self, delimiter: &'b str) -> Self

Separator for CSV results

pub fn error_trace(self, error_trace: bool) -> Self

Include the stack trace of returned errors.

pub fn filter_path(self, filter_path: &'b [&'b str]) -> Self

A comma-separated list of filters used to reduce the response.

pub fn format(self, format: &'b str) -> Self

Short version of the Accept header, e.g. json, yaml

pub fn header(self, key: HeaderName, value: HeaderValue) -> Self

Adds a HTTP header

pub fn human(self, human: bool) -> Self

Return human readable values for statistics.

pub fn keep_alive(self, keep_alive: &'b str) -> Self

Retention period for the search and its results

pub fn pretty(self, pretty: bool) -> Self

Pretty format the returned JSON response.

pub fn request_timeout(self, timeout: Duration) -> Self

Sets a request timeout for this API call.

The timeout is applied from when the request starts connecting until the response body has finished.

pub fn source(self, source: &'b str) -> Self

The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

pub fn wait_for_completion_timeout(
    self,
    wait_for_completion_timeout: &'b str
) -> Self

Duration to wait for complete results

pub async fn send(self) -> Result<Response, Error>

Creates an asynchronous call to the Sql Get Async API that can be awaited

Trait Implementations

impl<'a, 'b> Clone for SqlGetAsync<'a, 'b>

fn clone(&self) -> SqlGetAsync<'a, 'b>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, 'b> Debug for SqlGetAsync<'a, 'b>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.