Struct TemplateServiceAsyncClient

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

TemplateService manages templates, which are workbooks that can be re-used across runs. Templates are versioned.

Implementations

impl<T> TemplateServiceAsyncClient<T>

where T: AsyncClient,

pub async fn create( &self, auth_: &BearerToken, request: &CreateTemplateRequest, ) -> Result<Template, Error>

Creates a new template.

pub async fn get( &self, auth_: &BearerToken, template_rid: &TemplateRid, branch: Option<&BranchName>, commit: Option<&CommitId>, ) -> Result<Template, Error>

Must only pass one of (branch, commit). If neither are passed, the latest commit on the “main” branch is returned. Throws if the template, branch, or commit doesn’t exist.

pub async fn batch_get_metadata( &self, auth_: &BearerToken, rids: &BTreeSet<TemplateRid>, ) -> Result<BTreeSet<TemplateSummary>, Error>

pub async fn save_working_state( &self, auth_: &BearerToken, template_rid: &TemplateRid, branch: Option<&BranchName>, request: &SaveTemplateRequest, ) -> Result<Template, Error>

Creates a commit that may be compacted, e.g cleaned up and not exist anymore. Throws if the template or branch doesn’t exist. Throws if the latest commit doesn’t match the provided id. Throws if you save to an archived template.

pub async fn get_used_ref_names( &self, auth_: &BearerToken, template_rid: &TemplateRid, branch: Option<&BranchName>, commit: Option<&CommitId>, ) -> Result<BTreeSet<DataSourceRefName>, Error>

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

pub async fn update_ref_names( &self, auth_: &BearerToken, template_rid: &TemplateRid, branch: Option<&BranchName>, request: &UpdateRefNameRequest, ) -> Result<Template, Error>

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

pub async fn commit( &self, auth_: &BearerToken, template_rid: &TemplateRid, branch: Option<&BranchName>, request: &CommitTemplateRequest, ) -> Result<Template, Error>

Creates a commit with a commit message. Throws if the template or branch doesn’t exist. Throws if the latest commit doesn’t match the provided id. Throws if you commit to an archived template.

pub async fn update_metadata( &self, auth_: &BearerToken, template_rid: &TemplateRid, request: &UpdateMetadataRequest, ) -> Result<TemplateMetadata, Error>

Throws if the template doesn’t exist.

pub async fn search_templates( &self, auth_: &BearerToken, request: &SearchTemplatesRequest, ) -> Result<SearchTemplatesResponse, Error>

pub async fn get_all_labels_and_properties( &self, auth_: &BearerToken, workspaces: &BTreeSet<WorkspaceRid>, ) -> Result<GetAllLabelsAndPropertiesResponse, Error>

pub async fn merge_to_main( &self, auth_: &BearerToken, template_rid: &TemplateRid, request: &MergeToMainRequest, ) -> Result<Template, Error>

Merges the given branch to the “main” branch. Throws if the template or branch doesn’t exist. Throws if the latest commit doesn’t match the provided id. Throws if you merge on an archived template.

Trait Implementations

impl<T> AsyncService<T> for TemplateServiceAsyncClient<T>

where T: AsyncClient,

fn new(client: T) -> Self

Creates a new service wrapping an async HTTP client.

impl<T: Clone> Clone for TemplateServiceAsyncClient<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for TemplateServiceAsyncClient<T>

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

Formats the value using the given formatter.