Skip to main content

DocboxManagementInterface

docbox_management_interface

Trait DocboxManagementInterface 

Source 
pub trait DocboxManagementInterface {

Show 13 methods    // Required methods
    fn check_root<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<CheckRootOutput, ManagementError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn create_root<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<(), ManagementError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn create_tenant<'life0, 'async_trait>(
        &'life0 self,
        input: CreateTenantInput,
    ) -> Pin<Box<dyn Future<Output = Result<CreateTenantOutput, ManagementError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_tenant<'life0, 'async_trait>(
        &'life0 self,
        input: GetTenantInput,
    ) -> Pin<Box<dyn Future<Output = Result<GetTenantOutput, ManagementError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn delete_tenant<'life0, 'async_trait>(
        &'life0 self,
        input: DeleteTenantInput,
    ) -> Pin<Box<dyn Future<Output = Result<DeleteTenantOutput, ManagementError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_tenants<'life0, 'async_trait>(
        &'life0 self,
        input: GetTenantsInput,
    ) -> Pin<Box<dyn Future<Output = Result<GetTenantsOutput, ManagementError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn set_tenant_allowed_cors_origins<'life0, 'async_trait>(
        &'life0 self,
        input: SetTenantAllowedCorsOriginsInput,
    ) -> Pin<Box<dyn Future<Output = Result<(), ManagementError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn migrate_root<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<(), ManagementError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn migrate_tenant<'life0, 'async_trait>(
        &'life0 self,
        input: MigrateTenantInput,
    ) -> Pin<Box<dyn Future<Output = Result<MigrateTenantOutput, ManagementError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn migrate_tenant_iam<'life0, 'async_trait>(
        &'life0 self,
        input: MigrateTenantIAMInput,
    ) -> Pin<Box<dyn Future<Output = Result<MigrateTenantIAMOutput, ManagementError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_pending_root_migrations<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, ManagementError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_tenant_pending_migrations<'life0, 'async_trait>(
        &'life0 self,
        input: GetTenantPendingMigrationsInput,
    ) -> Pin<Box<dyn Future<Output = Result<GetTenantPendingMigrationsOutput, ManagementError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn flush_tenant_cache<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<(), ManagementError>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;

}
Expand description

Management interface providing the management functionality with an abstracted backend to allow the various points of management (CLI, Management Lambda, ..etc)

Required Methods§

Source

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

Checks if the docbox root database has been initialized

Source

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

Create the root docbox database

Source

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

Create a new tenant

Source

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

Get a specific tenant

Source

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

Delete a specific tenant

Source

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

Get a collection of tenants

Source

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

Set the allowed CORS origins for a tenants storage bucket

Source

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

Apply root database migrations

Source

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

Apply migrations for tenant(s)

Source

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

Migrate a tenant from secrets based authentication to IAM based database authentication

Source

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

Get migrations that are waiting to be applied to the root

Source

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

Get pending database migrations for a specific tenant

Source

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

Flush the tenant database cache for persisted servers

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§