Package Classes (0.5.9)

Summary of entries of Classes for workstations.

Classes

WorkstationsAsyncClient

Service for interacting with Cloud Workstations.

WorkstationsClient

Service for interacting with Cloud Workstations.

ListUsableWorkstationConfigsAsyncPager

A pager for iterating through list_usable_workstation_configs requests.

This class thinly wraps an initial ListUsableWorkstationConfigsResponse object, and provides an __aiter__ method to iterate through its workstation_configs field.

If there are more pages, the __aiter__ method will make additional ListUsableWorkstationConfigs requests and continue to iterate through the workstation_configs field on the corresponding responses.

All the usual ListUsableWorkstationConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListUsableWorkstationConfigsPager

A pager for iterating through list_usable_workstation_configs requests.

This class thinly wraps an initial ListUsableWorkstationConfigsResponse object, and provides an __iter__ method to iterate through its workstation_configs field.

If there are more pages, the __iter__ method will make additional ListUsableWorkstationConfigs requests and continue to iterate through the workstation_configs field on the corresponding responses.

All the usual ListUsableWorkstationConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListUsableWorkstationsAsyncPager

A pager for iterating through list_usable_workstations requests.

This class thinly wraps an initial ListUsableWorkstationsResponse object, and provides an __aiter__ method to iterate through its workstations field.

If there are more pages, the __aiter__ method will make additional ListUsableWorkstations requests and continue to iterate through the workstations field on the corresponding responses.

All the usual ListUsableWorkstationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListUsableWorkstationsPager

A pager for iterating through list_usable_workstations requests.

This class thinly wraps an initial ListUsableWorkstationsResponse object, and provides an __iter__ method to iterate through its workstations field.

If there are more pages, the __iter__ method will make additional ListUsableWorkstations requests and continue to iterate through the workstations field on the corresponding responses.

All the usual ListUsableWorkstationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListWorkstationClustersAsyncPager

A pager for iterating through list_workstation_clusters requests.

This class thinly wraps an initial ListWorkstationClustersResponse object, and provides an __aiter__ method to iterate through its workstation_clusters field.

If there are more pages, the __aiter__ method will make additional ListWorkstationClusters requests and continue to iterate through the workstation_clusters field on the corresponding responses.

All the usual ListWorkstationClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListWorkstationClustersPager

A pager for iterating through list_workstation_clusters requests.

This class thinly wraps an initial ListWorkstationClustersResponse object, and provides an __iter__ method to iterate through its workstation_clusters field.

If there are more pages, the __iter__ method will make additional ListWorkstationClusters requests and continue to iterate through the workstation_clusters field on the corresponding responses.

All the usual ListWorkstationClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListWorkstationConfigsAsyncPager

A pager for iterating through list_workstation_configs requests.

This class thinly wraps an initial ListWorkstationConfigsResponse object, and provides an __aiter__ method to iterate through its workstation_configs field.

If there are more pages, the __aiter__ method will make additional ListWorkstationConfigs requests and continue to iterate through the workstation_configs field on the corresponding responses.

All the usual ListWorkstationConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListWorkstationConfigsPager

A pager for iterating through list_workstation_configs requests.

This class thinly wraps an initial ListWorkstationConfigsResponse object, and provides an __iter__ method to iterate through its workstation_configs field.

If there are more pages, the __iter__ method will make additional ListWorkstationConfigs requests and continue to iterate through the workstation_configs field on the corresponding responses.

All the usual ListWorkstationConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListWorkstationsAsyncPager

A pager for iterating through list_workstations requests.

This class thinly wraps an initial ListWorkstationsResponse object, and provides an __aiter__ method to iterate through its workstations field.

If there are more pages, the __aiter__ method will make additional ListWorkstations requests and continue to iterate through the workstations field on the corresponding responses.

All the usual ListWorkstationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListWorkstationsPager

A pager for iterating through list_workstations requests.

This class thinly wraps an initial ListWorkstationsResponse object, and provides an __iter__ method to iterate through its workstations field.

If there are more pages, the __iter__ method will make additional ListWorkstations requests and continue to iterate through the workstations field on the corresponding responses.

All the usual ListWorkstationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

CreateWorkstationClusterRequest

Message for creating a CreateWorkstationCluster.

CreateWorkstationConfigRequest

Message for creating a CreateWorkstationConfig.

CreateWorkstationRequest

Message for creating a CreateWorkstation.

DeleteWorkstationClusterRequest

Message for deleting a workstation cluster.

DeleteWorkstationConfigRequest

Message for deleting a workstation configuration.

DeleteWorkstationRequest

Request message for DeleteWorkstation.

GenerateAccessTokenRequest

Request message for GenerateAccessToken.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GenerateAccessTokenResponse

Response message for GenerateAccessToken.

GetWorkstationClusterRequest

Request message for GetWorkstationCluster.

GetWorkstationConfigRequest

Request message for GetWorkstationConfig.

GetWorkstationRequest

Request message for GetWorkstation.

ListUsableWorkstationConfigsRequest

Request message for ListUsableWorkstationConfigs.

ListUsableWorkstationConfigsResponse

Response message for ListUsableWorkstationConfigs.

ListUsableWorkstationsRequest

Request message for ListUsableWorkstations.

ListUsableWorkstationsResponse

Response message for ListUsableWorkstations.

ListWorkstationClustersRequest

Request message for ListWorkstationClusters.

ListWorkstationClustersResponse

Response message for ListWorkstationClusters.

ListWorkstationConfigsRequest

Request message for ListWorkstationConfigs.

ListWorkstationConfigsResponse

Response message for ListWorkstationConfigs.

ListWorkstationsRequest

Request message for ListWorkstations.

ListWorkstationsResponse

Response message for ListWorkstations.

OperationMetadata

Metadata for long-running operations.

StartWorkstationRequest

Request message for StartWorkstation.

StopWorkstationRequest

Request message for StopWorkstation.

UpdateWorkstationClusterRequest

Request message for UpdateWorkstationCluster.

UpdateWorkstationConfigRequest

Request message for UpdateWorkstationConfig.

UpdateWorkstationRequest

Request message for UpdateWorkstation.

Workstation

A single instance of a developer workstation with its own persistent storage.

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

State

Whether a workstation is running and ready to receive user requests.

WorkstationCluster

A workstation cluster resource in the Cloud Workstations API.

Defines a group of workstations in a particular region and the VPC network they're attached to.

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

PrivateClusterConfig

Configuration options for private workstation clusters.

WorkstationConfig

A workstation configuration resource in the Cloud Workstations API.

Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use Identity and Access Management (IAM) <https://cloud.google.com/iam/docs/overview>__ rules to grant access to teams or to individual developers.

AnnotationsEntry

The abstract base class for a message.

Container

A Docker container.

EnvEntry

The abstract base class for a message.

CustomerEncryptionKey

A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow Cloud KMS best practices <https://cloud.google.com/kms/docs/separation-of-duties>__.

Host

Runtime host for a workstation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GceInstance

A runtime using a Compute Engine instance.

GceConfidentialInstanceConfig

A set of Compute Engine Confidential VM instance options.

GceShieldedInstanceConfig

A set of Compute Engine Shielded instance options.

LabelsEntry

The abstract base class for a message.

PersistentDirectory

A directory to persist across workstation sessions.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GceRegionalPersistentDisk

A PersistentDirectory backed by a Compute Engine regional persistent disk. The persistent_directories field is repeated, but it may contain only one entry. It creates a persistent disk <https://cloud.google.com/compute/docs/disks/persistent-disks>__ that mounts to the workstation VM at /home when the session starts and detaches when the session ends. If this field is empty, workstations created with this configuration do not have a persistent home directory.

ReclaimPolicy

Value representing what should happen to the disk after the workstation is deleted.

ReadinessCheck

A readiness check to be performed on a workstation.

WorkstationsAsyncClient

Service for interacting with Cloud Workstations.

WorkstationsClient

Service for interacting with Cloud Workstations.

ListUsableWorkstationConfigsAsyncPager

A pager for iterating through list_usable_workstation_configs requests.

This class thinly wraps an initial ListUsableWorkstationConfigsResponse object, and provides an __aiter__ method to iterate through its workstation_configs field.

All the usual ListUsableWorkstationConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListUsableWorkstationConfigsPager

A pager for iterating through list_usable_workstation_configs requests.

This class thinly wraps an initial ListUsableWorkstationConfigsResponse object, and provides an __iter__ method to iterate through its workstation_configs field.

All the usual ListUsableWorkstationConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListUsableWorkstationsAsyncPager

A pager for iterating through list_usable_workstations requests.

This class thinly wraps an initial ListUsableWorkstationsResponse object, and provides an __aiter__ method to iterate through its workstations field.

If there are more pages, the __aiter__ method will make additional ListUsableWorkstations requests and continue to iterate through the workstations field on the corresponding responses.

All the usual ListUsableWorkstationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListUsableWorkstationsPager

A pager for iterating through list_usable_workstations requests.

This class thinly wraps an initial ListUsableWorkstationsResponse object, and provides an __iter__ method to iterate through its workstations field.

If there are more pages, the __iter__ method will make additional ListUsableWorkstations requests and continue to iterate through the workstations field on the corresponding responses.

All the usual ListUsableWorkstationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListWorkstationClustersAsyncPager

A pager for iterating through list_workstation_clusters requests.

This class thinly wraps an initial ListWorkstationClustersResponse object, and provides an __aiter__ method to iterate through its workstation_clusters field.

All the usual ListWorkstationClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListWorkstationClustersPager

A pager for iterating through list_workstation_clusters requests.

This class thinly wraps an initial ListWorkstationClustersResponse object, and provides an __iter__ method to iterate through its workstation_clusters field.

If there are more pages, the __iter__ method will make additional ListWorkstationClusters requests and continue to iterate through the workstation_clusters field on the corresponding responses.

All the usual ListWorkstationClustersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListWorkstationConfigsAsyncPager

A pager for iterating through list_workstation_configs requests.

This class thinly wraps an initial ListWorkstationConfigsResponse object, and provides an __aiter__ method to iterate through its workstation_configs field.

If there are more pages, the __aiter__ method will make additional ListWorkstationConfigs requests and continue to iterate through the workstation_configs field on the corresponding responses.

All the usual ListWorkstationConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListWorkstationConfigsPager

A pager for iterating through list_workstation_configs requests.

This class thinly wraps an initial ListWorkstationConfigsResponse object, and provides an __iter__ method to iterate through its workstation_configs field.

If there are more pages, the __iter__ method will make additional ListWorkstationConfigs requests and continue to iterate through the workstation_configs field on the corresponding responses.

All the usual ListWorkstationConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListWorkstationsAsyncPager

A pager for iterating through list_workstations requests.

This class thinly wraps an initial ListWorkstationsResponse object, and provides an __aiter__ method to iterate through its workstations field.

If there are more pages, the __aiter__ method will make additional ListWorkstations requests and continue to iterate through the workstations field on the corresponding responses.

All the usual ListWorkstationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListWorkstationsPager

A pager for iterating through list_workstations requests.

This class thinly wraps an initial ListWorkstationsResponse object, and provides an __iter__ method to iterate through its workstations field.

If there are more pages, the __iter__ method will make additional ListWorkstations requests and continue to iterate through the workstations field on the corresponding responses.

All the usual ListWorkstationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Modules

pagers

API documentation for workstations_v1.services.workstations.pagers module.

pagers

API documentation for workstations_v1beta.services.workstations.pagers module.