Struct elasticsearch::cluster::ClusterState
source · pub struct ClusterState<'a, 'b> { /* private fields */ }
Expand description
Builder for the Cluster State API
Returns a comprehensive information about the state of the cluster.
Implementations
sourceimpl<'a, 'b> ClusterState<'a, 'b>
impl<'a, 'b> ClusterState<'a, 'b>
sourcepub fn new(transport: &'a Transport, parts: ClusterStateParts<'b>) -> Self
pub fn new(transport: &'a Transport, parts: ClusterStateParts<'b>) -> Self
Creates a new instance of ClusterState with the specified API parts
sourcepub fn allow_no_indices(self, allow_no_indices: bool) -> Self
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)
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 flat_settings(self, flat_settings: bool) -> Self
pub fn flat_settings(self, flat_settings: bool) -> Self
Return settings in flat format (default: false)
sourcepub fn header(self, key: HeaderName, value: HeaderValue) -> Self
pub fn header(self, key: HeaderName, value: HeaderValue) -> Self
Adds a HTTP header
Whether specified concrete indices should be ignored when unavailable (missing or closed)
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
Specify timeout for connection to master
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_metadata_version(self, wait_for_metadata_version: i64) -> Self
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
sourcepub fn wait_for_timeout(self, wait_for_timeout: &'b str) -> Self
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
Trait Implementations
sourceimpl<'a, 'b> Clone for ClusterState<'a, 'b>
impl<'a, 'b> Clone for ClusterState<'a, 'b>
sourcefn clone(&self) -> ClusterState<'a, 'b>
fn clone(&self) -> ClusterState<'a, 'b>
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more