Skip to main content

ClusterApiClient

Struct ClusterApiClient 

Source
pub struct ClusterApiClient { /* private fields */ }

Implementations§

Source§

impl ClusterApiClient

Source

pub fn new(configuration: Arc<Configuration>) -> Self

Source

pub fn get_settings<'f1>(&'f1 self) -> ClusterApiClientGetSettingsBuilder<'f1>

Returns cluster settings.

Source

pub fn get_decommission_awareness<'f1>( &'f1 self, ) -> ClusterApiClientGetDecommissionAwarenessBuilder<'f1>

Retrieves the decommission status for all zones.

Source

pub fn put_settings<'f1>(&'f1 self) -> ClusterApiClientPutSettingsBuilder<'f1>

Updates the cluster settings.

Source

pub fn delete_component_template<'f1>( &'f1 self, ) -> ClusterApiClientDeleteComponentTemplateBuilder<'f1>

Deletes a component template.

Source

pub fn exists_component_template<'f1>( &'f1 self, ) -> ClusterApiClientExistsComponentTemplateBuilder<'f1>

Returns information about whether a particular component template exist.

Source

pub fn get_component_template<'f1>( &'f1 self, ) -> ClusterApiClientGetComponentTemplateBuilder<'f1>

Returns one or more component templates.

Source

pub fn delete_decommission_awareness<'f1>( &'f1 self, ) -> ClusterApiClientDeleteDecommissionAwarenessBuilder<'f1>

Recommissions a decommissioned zone.

Source

pub fn get_weighted_routing<'f1>( &'f1 self, ) -> ClusterApiClientGetWeightedRoutingBuilder<'f1>

Fetches weighted shard routing weights.

Source

pub fn delete_weighted_routing<'f1>( &'f1 self, ) -> ClusterApiClientDeleteWeightedRoutingBuilder<'f1>

Delete weighted shard routing weights.

Source

pub fn post_voting_config_exclusions<'f1>( &'f1 self, ) -> ClusterApiClientPostVotingConfigExclusionsBuilder<'f1>

Updates the cluster voting configuration by excluding certain node IDs or names.

Source

pub fn pending_tasks<'f1>(&'f1 self) -> ClusterApiClientPendingTasksBuilder<'f1>

Returns a list of pending cluster-level tasks, such as index creation, mapping updates, or new allocations.

Source

pub fn reroute<'f1>(&'f1 self) -> ClusterApiClientRerouteBuilder<'f1>

Allows to manually change the allocation of individual shards in the cluster.

Source

pub fn allocation_explain<'f1>( &'f1 self, ) -> ClusterApiClientAllocationExplainBuilder<'f1>

Explains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can’t be allocated to a node.

Source

pub fn put_decommission_awareness<'f1>( &'f1 self, ) -> ClusterApiClientPutDecommissionAwarenessBuilder<'f1>

Decommissions a cluster zone based on awareness. This can greatly benefit multi-zone deployments, where awareness attributes can aid in applying new upgrades to a cluster in a controlled fashion.

Source

pub fn health<'f1>(&'f1 self) -> ClusterApiClientHealthBuilder<'f1>

Returns basic information about the health of the cluster.

Source

pub fn remote_info<'f1>(&'f1 self) -> ClusterApiClientRemoteInfoBuilder<'f1>

Returns the information about configured remote clusters.

Source

pub fn stats<'f1>(&'f1 self) -> ClusterApiClientStatsBuilder<'f1>

Returns a high-level overview of cluster statistics.

Source

pub fn put_weighted_routing<'f1>( &'f1 self, ) -> ClusterApiClientPutWeightedRoutingBuilder<'f1>

Updates weighted shard routing weights.

Source

pub fn put_component_template<'f1>( &'f1 self, ) -> ClusterApiClientPutComponentTemplateBuilder<'f1>

Creates or updates a component template.

Source

pub fn delete_voting_config_exclusions<'f1>( &'f1 self, ) -> ClusterApiClientDeleteVotingConfigExclusionsBuilder<'f1>

Clears any cluster voting configuration exclusions.

Source

pub fn state<'f1>(&'f1 self) -> ClusterApiClientStateBuilder<'f1>

Returns comprehensive information about the state of the cluster.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more