Struct AsyncNotebookServiceClient 

pub struct AsyncNotebookServiceClient<C> { /* private fields */ }

Trait Implementations

impl<I: Stream<Item = Result<Bytes, Error>>, __C> AsyncNotebookService<I> for AsyncNotebookServiceClient<__C>

where __C: AsyncClient<ResponseBody = I> + Sync + Send, __C::ResponseBody: 'static + Send,

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

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

Updates the contents of a workbook.

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

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

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

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

Updates metadata about a workbook, but not its contents.

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

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

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

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

async fn batch_edit_notebook_metadata( &self, auth_: &BearerToken, request: &BatchEditNotebookMetadataRequest, ) -> Result<BatchEditNotebookMetadataResponse, Error>

Batch edits metadata across multiple workbooks. Supports rename/merge for labels and properties. If more than 1000 workbooks are targeted, this endpoint will throw a 400.

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

Makes a workbook uneditable. Deprecated: use the isLocked field on updateMetadata instead.

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

Unlocks a workbook for editing. Deprecated: use the isLocked field on updateMetadata instead.

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

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

Makes a previously archived workbook searchable.

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

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

async fn duplicate( &self, auth_: &BearerToken, rid: &NotebookRid, request: &DuplicateNotebookRequest, ) -> Result<Notebook, Error>

Duplicates an existing workbook, copying its content (layout, charts, variables, pinned events) and optionally overriding metadata fields such as title, description, data scope, labels, and properties. Returns the newly created workbook.

async fn get_snapshot_history( &self, auth_: &BearerToken, request: &GetSnapshotHistoryRequest, ) -> Result<GetSnapshotHistoryResponse, Error>

Retrieves the snapshot history for a given workbook. These are sorted in reverse chronological order. Results are limited by page size.

impl<C> AsyncService<C> for AsyncNotebookServiceClient<C>

fn new(client: C, runtime: &Arc<ConjureRuntime>) -> Self

Creates a new service wrapping an async HTTP client.

impl<C: Clone> Clone for AsyncNotebookServiceClient<C>

fn clone(&self) -> AsyncNotebookServiceClient<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for AsyncNotebookServiceClient<C>

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

Formats the value using the given formatter.