Struct elasticsearch::cluster::ClusterHealth
source · pub struct ClusterHealth<'a, 'b> { /* private fields */ }
Expand description
Builder for the Cluster Health API
Returns basic information about the health of the cluster.
Implementations
sourceimpl<'a, 'b> ClusterHealth<'a, 'b>
impl<'a, 'b> ClusterHealth<'a, 'b>
sourcepub fn new(transport: &'a Transport, parts: ClusterHealthParts<'b>) -> Self
pub fn new(transport: &'a Transport, parts: ClusterHealthParts<'b>) -> Self
Creates a new instance of ClusterHealth with the specified API parts
sourcepub fn error_trace(self, error_trace: bool) -> Self
pub fn error_trace(self, error_trace: bool) -> Self
Include the stack trace of returned errors.
sourcepub fn expand_wildcards(self, expand_wildcards: &'b [ExpandWildcards]) -> Self
pub fn expand_wildcards(self, expand_wildcards: &'b [ExpandWildcards]) -> Self
Whether to expand wildcard expression to concrete indices that are open, closed or both.
sourcepub fn filter_path(self, filter_path: &'b [&'b str]) -> Self
pub fn filter_path(self, filter_path: &'b [&'b str]) -> Self
A comma-separated list of filters used to reduce the response.
sourcepub fn header(self, key: HeaderName, value: HeaderValue) -> Self
pub fn header(self, key: HeaderName, value: HeaderValue) -> Self
Adds a HTTP header
sourcepub fn local(self, local: bool) -> Self
pub fn local(self, local: bool) -> Self
Return local information, do not retrieve the state from master node (default: false)
sourcepub fn master_timeout(self, master_timeout: &'b str) -> Self
pub fn master_timeout(self, master_timeout: &'b str) -> Self
Explicit operation timeout for connection to master node
sourcepub fn request_timeout(self, timeout: Duration) -> Self
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.
sourcepub fn source(self, source: &'b str) -> Self
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.
sourcepub fn wait_for_active_shards(self, wait_for_active_shards: &'b str) -> Self
pub fn wait_for_active_shards(self, wait_for_active_shards: &'b str) -> Self
Wait until the specified number of shards is active
sourcepub fn wait_for_events(self, wait_for_events: WaitForEvents) -> Self
pub fn wait_for_events(self, wait_for_events: WaitForEvents) -> Self
Wait until all currently queued events with the given priority are processed
sourcepub fn wait_for_no_initializing_shards(
self,
wait_for_no_initializing_shards: bool
) -> Self
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
sourcepub fn wait_for_no_relocating_shards(
self,
wait_for_no_relocating_shards: bool
) -> Self
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
sourcepub fn wait_for_nodes(self, wait_for_nodes: &'b str) -> Self
pub fn wait_for_nodes(self, wait_for_nodes: &'b str) -> Self
Wait until the specified number of nodes is available
sourcepub fn wait_for_status(self, wait_for_status: WaitForStatus) -> Self
pub fn wait_for_status(self, wait_for_status: WaitForStatus) -> Self
Wait until cluster is in a specific state
Trait Implementations
sourceimpl<'a, 'b> Clone for ClusterHealth<'a, 'b>
impl<'a, 'b> Clone for ClusterHealth<'a, 'b>
sourcefn clone(&self) -> ClusterHealth<'a, 'b>
fn clone(&self) -> ClusterHealth<'a, 'b>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more