Struct NotebookService 

pub struct NotebookService { /* private fields */ }

Implements a client for the Notebooks API.

Example

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

Service Description

API v2 service for Workbench Notebooks Instances.

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://notebooks.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 list_instances(&self) -> ListInstances

Lists instances in a given project and location.

pub fn get_instance(&self) -> GetInstance

Gets details of a single Instance.

pub fn create_instance(&self) -> CreateInstance

Creates a new Instance in a given project and location.

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_instance(&self) -> UpdateInstance

UpdateInstance updates an Instance.

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 delete_instance(&self) -> DeleteInstance

Deletes a single Instance.

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_instance(&self) -> StartInstance

Starts a notebook instance.

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_instance(&self) -> StopInstance

Stops a notebook instance.

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 reset_instance(&self) -> ResetInstance

Resets a notebook instance.

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 check_instance_upgradability(&self) -> CheckInstanceUpgradability

Checks whether a notebook instance is upgradable.

pub fn upgrade_instance(&self) -> UpgradeInstance

Upgrades a notebook instance to the latest version.

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 rollback_instance(&self) -> RollbackInstance

Rollbacks a notebook instance to the previous version.

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 diagnose_instance(&self) -> DiagnoseInstance

Creates a Diagnostic File and runs Diagnostic Tool given an Instance.

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.

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.