Struct Workstations 

pub struct Workstations { /* private fields */ }

Implements a client for the Cloud Workstations API.

Example

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

Service Description

Service for interacting with Cloud Workstations.

Configuration

To configure Workstations 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://workstations.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

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

Implementations

impl Workstations

pub fn builder() -> ClientBuilder

Returns a builder for Workstations.

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

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

where T: Workstations + '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 get_workstation_cluster(&self) -> GetWorkstationCluster

Returns the requested workstation cluster.

pub fn list_workstation_clusters(&self) -> ListWorkstationClusters

Returns all workstation clusters in the specified location.

pub fn create_workstation_cluster(&self) -> CreateWorkstationCluster

Creates a new workstation cluster.

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_workstation_cluster(&self) -> UpdateWorkstationCluster

Updates an existing workstation cluster.

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_workstation_cluster(&self) -> DeleteWorkstationCluster

Deletes the specified workstation cluster.

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_workstation_config(&self) -> GetWorkstationConfig

Returns the requested workstation configuration.

pub fn list_workstation_configs(&self) -> ListWorkstationConfigs

Returns all workstation configurations in the specified cluster.

pub fn list_usable_workstation_configs(&self) -> ListUsableWorkstationConfigs

Returns all workstation configurations in the specified cluster on which the caller has the “workstations.workstation.create” permission.

pub fn create_workstation_config(&self) -> CreateWorkstationConfig

Creates a new workstation configuration.

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_workstation_config(&self) -> UpdateWorkstationConfig

Updates an existing workstation configuration.

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_workstation_config(&self) -> DeleteWorkstationConfig

Deletes the specified workstation configuration.

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_workstation(&self) -> GetWorkstation

Returns the requested workstation.

pub fn list_workstations(&self) -> ListWorkstations

Returns all Workstations using the specified workstation configuration.

pub fn list_usable_workstations(&self) -> ListUsableWorkstations

Returns all workstations using the specified workstation configuration on which the caller has the “workstations.workstations.use” permission.

pub fn create_workstation(&self) -> CreateWorkstation

Creates a new workstation.

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_workstation(&self) -> UpdateWorkstation

Updates an existing workstation.

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_workstation(&self) -> DeleteWorkstation

Deletes the specified workstation.

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_workstation(&self) -> StartWorkstation

Starts running a workstation so that users can connect to it.

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_workstation(&self) -> StopWorkstation

Stops running a workstation, reducing costs.

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 generate_access_token(&self) -> GenerateAccessToken

Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation.

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 Workstations

fn clone(&self) -> Workstations

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Workstations

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

Formats the value using the given formatter.