Struct elasticsearch::cluster::ClusterHealth

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

Builder for the Cluster Health API

Returns basic information about the health of the cluster.

Implementations

impl<'a, 'b> ClusterHealth<'a, 'b>

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

Creates a new instance of ClusterHealth with the specified API parts

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

Specify the level of detail for returned information

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

Explicit operation timeout

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

Wait until the specified number of shards is active

pub fn wait_for_events(self, wait_for_events: WaitForEvents) -> Self

Wait until all currently queued events with the given priority are processed

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

Whether to wait until there are no initializing shards in the cluster

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

Whether to wait until there are no relocating shards in the cluster

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

Wait until the specified number of nodes is available

pub fn wait_for_status(self, wait_for_status: WaitForStatus) -> Self

Wait until cluster is in a specific state

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

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

Trait Implementations

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

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

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

Formats the value using the given formatter.