Struct elasticsearch::cat::CatHelp

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

Builder for the Cat Help API

Returns help for the Cat APIs.

Implementations

impl<'a, 'b> CatHelp<'a, 'b>

pub fn new(transport: &'a Transport) -> Self

Creates a new instance of CatHelp

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 header(self, key: HeaderName, value: HeaderValue) -> Self

Adds a HTTP header

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

Return help information

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

Return human readable values for statistics.

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 s(self, s: &'b [&'b str]) -> Self

Comma-separated list of column names or column aliases to sort by

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 async fn send(self) -> Result<Response, Error>

Creates an asynchronous call to the Cat Help API that can be awaited

Trait Implementations

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

fn clone(&self) -> CatHelp<'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 CatHelp<'a, 'b>

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

Formats the value using the given formatter.