Trait AsyncNotebookService

pub trait AsyncNotebookService {
    // Required methods
    fn create(
        &self,
        auth_: BearerToken,
        request: CreateNotebookRequest,
    ) -> impl Future<Output = Result<Notebook, Error>> + Send;
    fn update(
        &self,
        auth_: BearerToken,
        rid: NotebookRid,
        request: UpdateNotebookRequest,
    ) -> impl Future<Output = Result<Notebook, Error>> + Send;
    fn get(
        &self,
        auth_: BearerToken,
        rid: NotebookRid,
    ) -> impl Future<Output = Result<Notebook, Error>> + Send;
    fn batch_get(
        &self,
        auth_: BearerToken,
        rids: BTreeSet<NotebookRid>,
    ) -> impl Future<Output = Result<BTreeSet<Notebook>, Error>> + Send;
    fn batch_get_metadata(
        &self,
        auth_: BearerToken,
        rids: BTreeSet<NotebookRid>,
    ) -> impl Future<Output = Result<BTreeSet<NotebookMetadataWithRid>, Error>> + Send;
    fn update_metadata(
        &self,
        auth_: BearerToken,
        rid: NotebookRid,
        request: UpdateNotebookMetadataRequest,
    ) -> impl Future<Output = Result<NotebookMetadata, Error>> + Send;
    fn get_used_ref_names(
        &self,
        auth_: BearerToken,
        rid: NotebookRid,
    ) -> impl Future<Output = Result<BTreeSet<DataSourceRefName>, Error>> + Send;
    fn update_ref_names(
        &self,
        auth_: BearerToken,
        rid: NotebookRid,
        request: UpdateRefNameRequest,
    ) -> impl Future<Output = Result<Notebook, Error>> + Send;
    fn get_all_labels_and_properties(
        &self,
        auth_: BearerToken,
        workspaces: BTreeSet<WorkspaceRid>,
    ) -> impl Future<Output = Result<GetAllLabelsAndPropertiesResponse, Error>> + Send;
    fn search(
        &self,
        auth_: BearerToken,
        request: SearchNotebooksRequest,
    ) -> impl Future<Output = Result<SearchNotebooksResponse, Error>> + Send;
    fn lock(
        &self,
        auth_: BearerToken,
        rid: NotebookRid,
    ) -> impl Future<Output = Result<(), Error>> + Send;
    fn unlock(
        &self,
        auth_: BearerToken,
        rid: NotebookRid,
    ) -> impl Future<Output = Result<(), Error>> + Send;
    fn archive(
        &self,
        auth_: BearerToken,
        rid: NotebookRid,
    ) -> impl Future<Output = Result<(), Error>> + Send;
    fn unarchive(
        &self,
        auth_: BearerToken,
        rid: NotebookRid,
    ) -> impl Future<Output = Result<(), Error>> + Send;
    fn delete(
        &self,
        auth_: BearerToken,
        rid: NotebookRid,
    ) -> impl Future<Output = Result<(), Error>> + Send;
}

NotebookService manages workbooks (formerly known as notebooks).

Required Methods

fn create( &self, auth_: BearerToken, request: CreateNotebookRequest, ) -> impl Future<Output = Result<Notebook, Error>> + Send

Creates a new workbook. The workbook will be associated with the provided run. If the run does not exist, a RunNotFound error will be thrown.

fn update( &self, auth_: BearerToken, rid: NotebookRid, request: UpdateNotebookRequest, ) -> impl Future<Output = Result<Notebook, Error>> + Send

Updates the contents of a workbook.

fn get( &self, auth_: BearerToken, rid: NotebookRid, ) -> impl Future<Output = Result<Notebook, Error>> + Send

fn batch_get( &self, auth_: BearerToken, rids: BTreeSet<NotebookRid>, ) -> impl Future<Output = Result<BTreeSet<Notebook>, Error>> + Send

fn batch_get_metadata( &self, auth_: BearerToken, rids: BTreeSet<NotebookRid>, ) -> impl Future<Output = Result<BTreeSet<NotebookMetadataWithRid>, Error>> + Send

fn update_metadata( &self, auth_: BearerToken, rid: NotebookRid, request: UpdateNotebookMetadataRequest, ) -> impl Future<Output = Result<NotebookMetadata, Error>> + Send

Updates metadata about a workbook, but not its contents.

fn get_used_ref_names( &self, auth_: BearerToken, rid: NotebookRid, ) -> impl Future<Output = Result<BTreeSet<DataSourceRefName>, Error>> + Send

Returns the set of all ref names used by the workbook.

fn update_ref_names( &self, auth_: BearerToken, rid: NotebookRid, request: UpdateRefNameRequest, ) -> impl Future<Output = Result<Notebook, Error>> + Send

Updates the data source ref names for all variables used in the workbook.

fn get_all_labels_and_properties( &self, auth_: BearerToken, workspaces: BTreeSet<WorkspaceRid>, ) -> impl Future<Output = Result<GetAllLabelsAndPropertiesResponse, Error>> + Send

Returns all properties (key value pairs) and labels that have been previously used on workbook. These can be used to organize workbooks.

fn search( &self, auth_: BearerToken, request: SearchNotebooksRequest, ) -> impl Future<Output = Result<SearchNotebooksResponse, Error>> + Send

fn lock( &self, auth_: BearerToken, rid: NotebookRid, ) -> impl Future<Output = Result<(), Error>> + Send

Makes a workbook uneditable.

fn unlock( &self, auth_: BearerToken, rid: NotebookRid, ) -> impl Future<Output = Result<(), Error>> + Send

Unlocks a workbook for editing.

fn archive( &self, auth_: BearerToken, rid: NotebookRid, ) -> impl Future<Output = Result<(), Error>> + Send

Archives a workbook, which excludes it from search and hides it from being publicly visible, but does not permanently delete it. Archived workbooks can be unarchived.

fn unarchive( &self, auth_: BearerToken, rid: NotebookRid, ) -> impl Future<Output = Result<(), Error>> + Send

Makes a previously archived workbook searchable.

fn delete( &self, auth_: BearerToken, rid: NotebookRid, ) -> impl Future<Output = Result<(), Error>> + Send

The workbook will be deleted and is not recoverable. For soft deletion, use archive.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors