Skip to main content

AdminClient

rc_s3::admin

Struct AdminClient 

Source 
pub struct AdminClient { /* private fields */ }
Expand description

Admin API client for RustFS/MinIO-compatible servers

Implementations§

Source§

impl AdminClient

Source

pub fn new(alias: &Alias) -> Result<Self>

Create a new AdminClient from an Alias

Trait Implementations§

Source§

impl AdminApi for AdminClient

Source§

fn cluster_info<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ClusterInfo>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Get cluster information including servers, disks, and usage
Source§

fn heal_status<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<HealStatus>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Get current heal status
Source§

fn heal_start<'life0, 'async_trait>( &'life0 self, request: HealStartRequest, ) -> Pin<Box<dyn Future<Output = Result<HealStatus>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Start a heal operation
Source§

fn heal_stop<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Stop a running heal operation
Source§

fn list_pools<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<PoolStatus>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

List storage pools
Source§

fn pool_status<'life0, 'async_trait>( &'life0 self, target: PoolTarget, ) -> Pin<Box<dyn Future<Output = Result<PoolStatus>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Get storage pool status
Source§

fn decommission_start<'life0, 'async_trait>( &'life0 self, target: PoolTarget, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Start decommissioning one or more storage pools
Source§

fn decommission_cancel<'life0, 'async_trait>( &'life0 self, target: PoolTarget, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Cancel decommissioning a storage pool
Source§

fn rebalance_start<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<RebalanceStartResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Start a rebalance operation
Source§

fn rebalance_status<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<RebalanceStatus>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Get rebalance status
Source§

fn rebalance_stop<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Stop a running rebalance operation
Source§

fn list_users<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<User>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

List all users
Source§

fn get_user<'life0, 'life1, 'async_trait>( &'life0 self, access_key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<User>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get user information
Source§

fn create_user<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, access_key: &'life1 str, secret_key: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<User>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Create a new user
Source§

fn delete_user<'life0, 'life1, 'async_trait>( &'life0 self, access_key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete a user
Source§

fn set_user_status<'life0, 'life1, 'async_trait>( &'life0 self, access_key: &'life1 str, status: UserStatus, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Set user status (enable/disable)
Source§

fn list_policies<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<PolicyInfo>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

List all policies
Source§

fn get_policy<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Policy>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get policy information
Source§

fn create_policy<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, name: &'life1 str, policy_document: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Create a new policy
Source§

fn delete_policy<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete a policy
Source§

fn attach_policy<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, policy_names: &'life1 [String], entity_type: PolicyEntity, entity_name: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Attach policy to a user or group
Source§

fn detach_policy<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, policy_names: &'life1 [String], entity_type: PolicyEntity, entity_name: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Detach policy from a user or group
Source§

fn list_groups<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

List all groups
Source§

fn get_group<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Group>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get group information
Source§

fn create_group<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, name: &'life1 str, members: Option<&'life2 [String]>, ) -> Pin<Box<dyn Future<Output = Result<Group>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Create a new group
Source§

fn delete_group<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete a group
Source§

fn set_group_status<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, status: GroupStatus, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Set group status (enable/disable)
Source§

fn add_group_members<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, group: &'life1 str, members: &'life2 [String], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Add members to a group
Source§

fn remove_group_members<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, group: &'life1 str, members: &'life2 [String], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Remove members from a group
Source§

fn list_service_accounts<'life0, 'life1, 'async_trait>( &'life0 self, user: Option<&'life1 str>, ) -> Pin<Box<dyn Future<Output = Result<Vec<ServiceAccount>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List service accounts for a user
Source§

fn get_service_account<'life0, 'life1, 'async_trait>( &'life0 self, access_key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<ServiceAccount>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get service account information
Source§

fn create_service_account<'life0, 'async_trait>( &'life0 self, request: CreateServiceAccountRequest, ) -> Pin<Box<dyn Future<Output = Result<ServiceAccount>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Create a new service account
Source§

fn delete_service_account<'life0, 'life1, 'async_trait>( &'life0 self, access_key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete a service account
Source§

fn set_bucket_quota<'life0, 'life1, 'async_trait>( &'life0 self, bucket: &'life1 str, quota: u64, ) -> Pin<Box<dyn Future<Output = Result<BucketQuota>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Set bucket quota in bytes
Source§

fn get_bucket_quota<'life0, 'life1, 'async_trait>( &'life0 self, bucket: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<BucketQuota>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get bucket quota information
Source§

fn clear_bucket_quota<'life0, 'life1, 'async_trait>( &'life0 self, bucket: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<BucketQuota>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Clear bucket quota
Source§

fn list_tiers<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<TierConfig>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

List all configured storage tiers
Source§

fn tier_stats<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Value>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Get tier statistics
Source§

fn add_tier<'life0, 'async_trait>( &'life0 self, config: TierConfig, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Add a new storage tier
Source§

fn edit_tier<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, creds: TierCreds, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Edit tier credentials
Source§

fn remove_tier<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, force: bool, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Remove a storage tier
Source§

fn set_remote_target<'life0, 'life1, 'async_trait>( &'life0 self, bucket: &'life1 str, target: BucketTarget, update: bool, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Set a remote replication target for a bucket, returns the ARN
Source§

fn list_remote_targets<'life0, 'life1, 'async_trait>( &'life0 self, bucket: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<BucketTarget>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List remote replication targets for a bucket
Source§

fn remove_remote_target<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, bucket: &'life1 str, arn: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Remove a remote replication target
Source§

fn replication_metrics<'life0, 'life1, 'async_trait>( &'life0 self, bucket: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Value>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get replication metrics for a bucket

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
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> Same for T

Source§

type Output = T

Should always be Self
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<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