Struct elasticsearch::cat::CatRecovery

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

Builder for the Cat Recovery API

Returns information about index shard recoveries, both on-going completed.

Implementations

impl<'a, 'b> CatRecovery<'a, 'b>

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

Creates a new instance of CatRecovery with the specified API parts

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

If true, the response only includes ongoing shard recoveries

pub fn bytes(self, bytes: Bytes) -> Self

The unit in which to display byte values

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

If true, the response includes detailed information about shard recoveries

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

a short version of the Accept header, e.g. json, yaml

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

Comma-separated list of column names to display

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

Comma-separated list or wildcard expression of index names to limit the returned information

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 fn time(self, time: Time) -> Self

The unit in which to display time values

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

Verbose mode. Display column headers

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

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

Trait Implementations

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

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

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

Formats the value using the given formatter.