Struct ClusterState

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

Builder for the Cluster State API

Returns a comprehensive information about the state of the cluster.

Implementations

impl<'a, 'b> ClusterState<'a, 'b>

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

Creates a new instance of ClusterState with the specified API parts

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

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

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

Return settings in flat format (default: false)

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

Whether specified concrete indices should be ignored when unavailable (missing or closed)

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

Specify timeout for connection to master

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_metadata_version(self, wait_for_metadata_version: i64) -> Self

Wait for the metadata version to be equal or greater than the specified metadata version

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

The maximum time to wait for wait_for_metadata_version before timing out

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

Creates an asynchronous call to the Cluster State API that can be awaited

Trait Implementations

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

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

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

Formats the value using the given formatter.