pub struct AdminApi { /* private fields */ }Expand description
In-process admin API that exposes cluster management operations.
Implementations§
Source§impl AdminApi
impl AdminApi
Sourcepub fn new(
config: Arc<ServerConfig>,
snapshot_manager: Arc<SnapshotManager>,
) -> Self
pub fn new( config: Arc<ServerConfig>, snapshot_manager: Arc<SnapshotManager>, ) -> Self
Create a new AdminApi instance.
Sourcepub async fn get_cluster_status(&self) -> ServerResult<ClusterStatusResponse>
pub async fn get_cluster_status(&self) -> ServerResult<ClusterStatusResponse>
Return the current cluster status.
When the cluster feature is disabled this always reports
is_leader = true (standalone mode) and zero shards / one node.
Sourcepub async fn create_snapshot(&self) -> ServerResult<SnapshotInfo>
pub async fn create_snapshot(&self) -> ServerResult<SnapshotInfo>
Create a new snapshot of the current server state.
The snapshot payload is a minimal status blob. In a full cluster implementation this would be the serialised state-machine snapshot.
Sourcepub async fn list_snapshots(&self) -> ServerResult<SnapshotListResponse>
pub async fn list_snapshots(&self) -> ServerResult<SnapshotListResponse>
Return the list of snapshots available on disk.
Sourcepub async fn restore_snapshot(&self, snapshot_id: u64) -> ServerResult<()>
pub async fn restore_snapshot(&self, snapshot_id: u64) -> ServerResult<()>
Restore state from the snapshot with the given snapshot_id.
Currently validates that the snapshot can be read and decompressed without error. Full state-machine restore is a Phase 8 task once the Raft leader drives apply.
Sourcepub async fn get_health(&self) -> ServerResult<HealthStatus>
pub async fn get_health(&self) -> ServerResult<HealthStatus>
Return overall health status for this node.
Auto Trait Implementations§
impl !RefUnwindSafe for AdminApi
impl !UnwindSafe for AdminApi
impl Freeze for AdminApi
impl Send for AdminApi
impl Sync for AdminApi
impl Unpin for AdminApi
impl UnsafeUnpin for AdminApi
Blanket Implementations§
Source§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
Source§type ArchivedMetadata = ()
type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
Source§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Converts some archived metadata to the pointer metadata for itself.
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::RequestSource§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
Source§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
Returns the layout of the type.
Source§impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
Source§unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
Returns whether the given value has been niched. Read more
Source§fn resolve_niched(out: Place<NichedOption<T, N1>>)
fn resolve_niched(out: Place<NichedOption<T, N1>>)
Writes data to
out indicating that a T is niched.