Trait NotebookService

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

NotebookService manages workbooks (formerly known as notebooks).

Required Methods

fn create( &self, auth_: BearerToken, request: CreateNotebookRequest, ) -> Result<Notebook, Error>

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, ) -> Result<Notebook, Error>

Updates the contents of a workbook.

fn get(&self, auth_: BearerToken, rid: NotebookRid) -> Result<Notebook, Error>

fn batch_get( &self, auth_: BearerToken, rids: BTreeSet<NotebookRid>, ) -> Result<BTreeSet<Notebook>, Error>

fn batch_get_metadata( &self, auth_: BearerToken, rids: BTreeSet<NotebookRid>, ) -> Result<BTreeSet<NotebookMetadataWithRid>, Error>

fn update_metadata( &self, auth_: BearerToken, rid: NotebookRid, request: UpdateNotebookMetadataRequest, ) -> Result<NotebookMetadata, Error>

Updates metadata about a workbook, but not its contents.

fn get_used_ref_names( &self, auth_: BearerToken, rid: NotebookRid, ) -> Result<BTreeSet<DataSourceRefName>, Error>

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

fn update_ref_names( &self, auth_: BearerToken, rid: NotebookRid, request: UpdateRefNameRequest, ) -> Result<Notebook, Error>

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>, ) -> Result<GetAllLabelsAndPropertiesResponse, Error>

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, ) -> Result<SearchNotebooksResponse, Error>

fn lock(&self, auth_: BearerToken, rid: NotebookRid) -> Result<(), Error>

Makes a workbook uneditable.

fn unlock(&self, auth_: BearerToken, rid: NotebookRid) -> Result<(), Error>

Unlocks a workbook for editing.

fn archive(&self, auth_: BearerToken, rid: NotebookRid) -> Result<(), Error>

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) -> Result<(), Error>

Makes a previously archived workbook searchable.

fn delete(&self, auth_: BearerToken, rid: NotebookRid) -> Result<(), Error>

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

Implementors