Struct NotebookService 

pub struct NotebookService { /* private fields */ }

Available on crate feature notebook-service only.

Implements a client for the Vertex AI API.

Example

let client = NotebookService::builder().build().await?;
// use `client` to make requests to the Vertex AI API.

Service Description

The interface for Vertex Notebook service (a.k.a. Colab on Workbench).

Configuration

To configure NotebookService use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

• with_endpoint(): by default this client uses the global default endpoint (https://aiplatform.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
• with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

Pooling and Cloning

NotebookService holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap NotebookService in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl NotebookService

pub fn builder() -> ClientBuilder

Returns a builder for NotebookService.

let client = NotebookService::builder().build().await?;

pub fn from_stub<T>(stub: T) -> Self

where T: NotebookService + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

pub fn create_notebook_runtime_template(&self) -> CreateNotebookRuntimeTemplate

Creates a NotebookRuntimeTemplate.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_notebook_runtime_template(&self) -> GetNotebookRuntimeTemplate

Gets a NotebookRuntimeTemplate.

pub fn list_notebook_runtime_templates(&self) -> ListNotebookRuntimeTemplates

Lists NotebookRuntimeTemplates in a Location.

pub fn delete_notebook_runtime_template(&self) -> DeleteNotebookRuntimeTemplate

Deletes a NotebookRuntimeTemplate.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_notebook_runtime_template(&self) -> UpdateNotebookRuntimeTemplate

Updates a NotebookRuntimeTemplate.

pub fn assign_notebook_runtime(&self) -> AssignNotebookRuntime

Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_notebook_runtime(&self) -> GetNotebookRuntime

Gets a NotebookRuntime.

pub fn list_notebook_runtimes(&self) -> ListNotebookRuntimes

Lists NotebookRuntimes in a Location.

pub fn delete_notebook_runtime(&self) -> DeleteNotebookRuntime

Deletes a NotebookRuntime.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn upgrade_notebook_runtime(&self) -> UpgradeNotebookRuntime

Upgrades a NotebookRuntime.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn start_notebook_runtime(&self) -> StartNotebookRuntime

Starts a NotebookRuntime.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn stop_notebook_runtime(&self) -> StopNotebookRuntime

Stops a NotebookRuntime.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn create_notebook_execution_job(&self) -> CreateNotebookExecutionJob

Creates a NotebookExecutionJob.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_notebook_execution_job(&self) -> GetNotebookExecutionJob

Gets a NotebookExecutionJob.

pub fn list_notebook_execution_jobs(&self) -> ListNotebookExecutionJobs

Lists NotebookExecutionJobs in a Location.

pub fn delete_notebook_execution_job(&self) -> DeleteNotebookExecutionJob

Deletes a NotebookExecutionJob.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self) -> GetLocation

Gets information about a location.

pub fn set_iam_policy(&self) -> SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

pub fn get_iam_policy(&self) -> GetIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

pub fn test_iam_permissions(&self) -> TestIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.

pub fn list_operations(&self) -> ListOperations

Provides the Operations service functionality in this service.

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

pub fn delete_operation(&self) -> DeleteOperation

Provides the Operations service functionality in this service.

pub fn cancel_operation(&self) -> CancelOperation

Provides the Operations service functionality in this service.

pub fn wait_operation(&self) -> WaitOperation

Provides the Operations service functionality in this service.

Trait Implementations

impl Clone for NotebookService

fn clone(&self) -> NotebookService

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NotebookService

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

Formats the value using the given formatter.