Struct elasticsearch::indices::IndicesStats

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

Builder for the Indices Stats API

Provides statistics on operations happening in an index.

Implementations

impl<'a, 'b> IndicesStats<'a, 'b>

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

Creates a new instance of IndicesStats with the specified API parts

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

A comma-separated list of fields for fielddata and suggest index metric (supports wildcards)

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

A comma-separated list of fields for fielddata index metric (supports wildcards)

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

A comma-separated list of fields for fielddata and completion index metric (supports wildcards)

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

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

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

If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices

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

A comma-separated list of search groups for search index metric

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

Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested)

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 level(self, level: Level) -> Self

Return stats aggregated at cluster, index or shard level

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

A comma-separated list of document types for the indexing index metric

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

Creates an asynchronous call to the Indices Stats API that can be awaited

Trait Implementations

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

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

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

Formats the value using the given formatter.