Package Classes (0.8.1)

Service for interacting with Cloud Workstations.

Service for interacting with Cloud Workstations.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Message for creating a CreateWorkstationCluster.

Message for creating a CreateWorkstationConfig.

Message for creating a CreateWorkstation.

Message for deleting a workstation cluster.

Message for deleting a workstation configuration.

Request message for DeleteWorkstation.

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

Response message for GenerateAccessToken.

Request message for GetWorkstationCluster.

Request message for GetWorkstationConfig.

Request message for GetWorkstation.

Request message for ListUsableWorkstationConfigs.

Response message for ListUsableWorkstationConfigs.

Request message for ListUsableWorkstations.

Response message for ListUsableWorkstations.

Request message for ListWorkstationClusters.

Response message for ListWorkstationClusters.

Request message for ListWorkstationConfigs.

Response message for ListWorkstationConfigs.

Request message for ListWorkstations.

Response message for ListWorkstations.

Metadata for long-running operations.

Request message for StartWorkstation.

Request message for StopWorkstation.

Request message for UpdateWorkstationCluster.

Request message for UpdateWorkstationConfig.

Request message for UpdateWorkstation.

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

The abstract base class for a message.

The abstract base class for a message.

The abstract base class for a message.

Runtime host for the workstation.

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

The Compute Engine instance host.

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

A directory to persist across workstation sessions. Updates to this field will only take effect on this workstation after it is restarted.

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.

The abstract base class for a message.

Configuration options for a custom domain.

Configuration options for Cluster HTTP Gateway.

The abstract base class for a message.

Configuration options for private workstation clusters.

The abstract base class for a message.

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.

The abstract base class for a message.

A Docker container.

The abstract base class for a message.

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>__.

An ephemeral directory which won't persist across workstation sessions. It is freshly created on every workstation start operation.

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

An EphemeralDirectory is backed by a Compute Engine persistent disk.

Runtime host for a workstation.

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

A runtime using a Compute Engine instance.

An accelerator card attached to the instance.

A boost configuration is a set of resources that a workstation can use to increase its performance. If you specify a boost configuration, upon startup, workstation users can choose to use a VM provisioned under the boost config by passing the boost config ID in the start request. If the workstation user does not provide a boost config ID in the start request, the system will choose a VM from the pool provisioned under the default config.

A set of Compute Engine Confidential VM instance options.

A set of Compute Engine Shielded instance options.

The abstract base class for a message.

The abstract base class for a message.

The abstract base class for a message.

A directory to persist across workstation sessions. Updates to this field will not update existing workstations and will only take effect on new workstations.

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

A Persistent Directory backed by a Compute Engine Hyperdisk Balanced High Availability Disk <https://cloud.google.com/compute/docs/disks/hd-types/hyperdisk-balanced-ha>__. This is a high-availability block storage solution that offers a balance between performance and cost for most general-purpose workloads.

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

A Persistent Directory 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.

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

A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.

A readiness check to be performed on a workstation.

Service for interacting with Cloud Workstations.

Service for interacting with Cloud Workstations.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Message for creating a CreateWorkstationCluster.

Message for creating a CreateWorkstationConfig.

Message for creating a CreateWorkstation.

Message for deleting a workstation cluster.

Message for deleting a workstation configuration.

Request message for DeleteWorkstation.

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

Response message for GenerateAccessToken.

Request message for GetWorkstationCluster.

Request message for GetWorkstationConfig.

Request message for GetWorkstation.

Request message for ListUsableWorkstationConfigs.

Response message for ListUsableWorkstationConfigs.

Request message for ListUsableWorkstations.

Response message for ListUsableWorkstations.

Request message for ListWorkstationClusters.

Response message for ListWorkstationClusters.

Request message for ListWorkstationConfigs.

Response message for ListWorkstationConfigs.

Request message for ListWorkstations.

Response message for ListWorkstations.

Metadata for long-running operations.

Metadata message for PushCredentials.

Request message for PushCredentials.

OAuth token.

Request message for StartWorkstation.

Request message for StopWorkstation.

Request message for UpdateWorkstationCluster.

Request message for UpdateWorkstationConfig.

Request message for UpdateWorkstation.

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

The abstract base class for a message.

The abstract base class for a message.

The abstract base class for a message.

Runtime host for the workstation.

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

The Compute Engine instance host.

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

Boost configuration for this workstation. This object is populated from the parent workstation configuration.

A directory to persist across workstation sessions. Updates to this field will only take effect on this workstation after it is restarted.

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.

The abstract base class for a message.

Configuration options for a custom domain.

Configuration options for Cluster HTTP Gateway.

The abstract base class for a message.

Configuration options for private workstation clusters.

The abstract base class for a message.

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.

The abstract base class for a message.

A Docker container.

The abstract base class for a message.

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>__.

An ephemeral directory which won't persist across workstation sessions. It is freshly created on every workstation start operation.

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

An EphemeralDirectory is backed by a Compute Engine persistent disk.

Runtime host for a workstation.

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

A runtime using a Compute Engine instance.

An accelerator card attached to the instance.

A boost configuration is a set of resources that a workstation can use to increase its performance. If you specify a boost configuration, upon startup, workstation users can choose to use a VM provisioned under the boost config by passing the boost config ID in the start request. If the workstation user does not provide a boost config ID in the start request, the system will choose a VM from the pool provisioned under the default config.

A set of Compute Engine Confidential VM instance options.

A set of Compute Engine Shielded instance options.

The abstract base class for a message.

ReservationAffinity is the configuration of the desired reservation from which instances can consume resources.

Indicates whether to consume capacity from a reservation or not.

The abstract base class for a message.

HTTP options for the running workstations.

The abstract base class for a message.

A directory to persist across workstation sessions. Updates to this field will not update existing workstations and will only take effect on new workstations.

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

A Persistent Directory backed by a Compute Engine Hyperdisk Balanced High Availability Disk <https://cloud.google.com/compute/docs/disks/hd-types/hyperdisk-balanced-ha>__. This is a high-availability block storage solution that offers a balance between performance and cost for most general-purpose workloads.

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

A Persistent Directory 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.

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

A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.

A readiness check to be performed on a workstation.

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

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