Struct elasticsearch::cat::CatIndices

pub struct CatIndices<'a, 'b> { /* fields omitted */ }

Builder for the Cat Indices API

Returns information about indices: number of primaries and replicas, document counts, disk size, ...

Implementations

impl<'a, 'b> CatIndices<'a, 'b>

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

Creates a new instance of CatIndices with the specified API parts

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

The unit in which to display byte values

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

Include the stack trace of returned errors.

pub fn expand_wildcards(self, expand_wildcards: &'b [ExpandWildcards]) -> Self

Whether to expand wildcard expression to concrete indices that are open, closed or both.

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 health(self, health: Health) -> Self

A health status ("green", "yellow", or "red" to filter only indices matching the specified health status

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 include_unloaded_segments(self, include_unloaded_segments: bool) -> Self

If set to true segment stats will include stats for segments that are not currently loaded into memory

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

Return local information, do not retrieve the state from master node (default: false)

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

Explicit operation timeout for connection to master node

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

Pretty format the returned JSON response.

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

Set to true to return stats only for primary shards

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 Indices API that can be awaited

Trait Implementations

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

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

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

Formats the value using the given formatter.