Struct NotebookServiceClient

pub struct NotebookServiceClient<T>(/* private fields */);

NotebookService manages workbooks (formerly known as notebooks).

Implementations

impl<T> NotebookServiceClient<T>

where T: Client,

pub 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.

pub fn update( &self, auth_: &BearerToken, rid: &NotebookRid, request: &UpdateNotebookRequest, ) -> Result<Notebook, Error>

Updates the contents of a workbook.

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

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

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

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

Updates metadata about a workbook, but not its contents.

pub 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.

pub 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.

pub 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.

pub fn search( &self, auth_: &BearerToken, request: &SearchNotebooksRequest, ) -> Result<SearchNotebooksResponse, Error>

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

Makes a workbook uneditable.

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

Unlocks a workbook for editing.

pub 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.

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

Makes a previously archived workbook searchable.

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

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

Trait Implementations

impl<T: Clone> Clone for NotebookServiceClient<T>

fn clone(&self) -> NotebookServiceClient<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for NotebookServiceClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Service<T> for NotebookServiceClient<T>

where T: Client,

fn new(client: T) -> Self

Creates a new service wrapping an HTTP client.