Index
-
Workstations(interface) -
CreateWorkstationClusterRequest(message) -
CreateWorkstationConfigRequest(message) -
CreateWorkstationRequest(message) -
DeleteWorkstationClusterRequest(message) -
DeleteWorkstationConfigRequest(message) -
DeleteWorkstationRequest(message) -
GenerateAccessTokenRequest(message) -
GenerateAccessTokenResponse(message) -
GetWorkstationClusterRequest(message) -
GetWorkstationConfigRequest(message) -
GetWorkstationRequest(message) -
ListUsableWorkstationConfigsRequest(message) -
ListUsableWorkstationConfigsResponse(message) -
ListUsableWorkstationsRequest(message) -
ListUsableWorkstationsResponse(message) -
ListWorkstationClustersRequest(message) -
ListWorkstationClustersResponse(message) -
ListWorkstationConfigsRequest(message) -
ListWorkstationConfigsResponse(message) -
ListWorkstationsRequest(message) -
ListWorkstationsResponse(message) -
OperationMetadata(message) -
StartWorkstationRequest(message) -
StopWorkstationRequest(message) -
UpdateWorkstationClusterRequest(message) -
UpdateWorkstationConfigRequest(message) -
UpdateWorkstationRequest(message) -
Workstation(message) -
Workstation.RuntimeHost(message) -
Workstation.RuntimeHost.GceInstanceHost(message) -
Workstation.State(enum) -
WorkstationCluster(message) -
WorkstationCluster.DomainConfig(message) -
WorkstationCluster.GatewayConfig(message) -
WorkstationCluster.PrivateClusterConfig(message) -
WorkstationConfig(message) -
WorkstationConfig.Container(message) -
WorkstationConfig.CustomerEncryptionKey(message) -
WorkstationConfig.EphemeralDirectory(message) -
WorkstationConfig.EphemeralDirectory.GcePersistentDisk(message) -
WorkstationConfig.Host(message) -
WorkstationConfig.Host.GceInstance(message) -
WorkstationConfig.Host.GceInstance.Accelerator(message) -
WorkstationConfig.Host.GceInstance.BoostConfig(message) -
WorkstationConfig.Host.GceInstance.GceConfidentialInstanceConfig(message) -
WorkstationConfig.Host.GceInstance.GceShieldedInstanceConfig(message) -
WorkstationConfig.PersistentDirectory(message) -
WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk(message) -
WorkstationConfig.PersistentDirectory.GceRegionalPersistentDisk.ReclaimPolicy(enum) -
WorkstationConfig.PortRange(message) -
WorkstationConfig.ReadinessCheck(message)
Workstations
Service for interacting with Cloud Workstations.
rpc CreateWorkstation(
CreateWorkstationRequest
) returns ( Operation
)
Creates a new workstation.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc CreateWorkstationCluster(
CreateWorkstationClusterRequest
) returns ( Operation
)
Creates a new workstation cluster.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc CreateWorkstationConfig(
CreateWorkstationConfigRequest
) returns ( Operation
)
Creates a new workstation configuration.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc DeleteWorkstation(
DeleteWorkstationRequest
) returns ( Operation
)
Deletes the specified workstation.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc DeleteWorkstationCluster(
DeleteWorkstationClusterRequest
) returns ( Operation
)
Deletes the specified workstation cluster.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc DeleteWorkstationConfig(
DeleteWorkstationConfigRequest
) returns ( Operation
)
Deletes the specified workstation configuration.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc GenerateAccessToken(
GenerateAccessTokenRequest
) returns ( GenerateAccessTokenResponse
)
Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation. Once generated this token cannot be revoked and is good for the lifetime of the token.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc GetWorkstation(
GetWorkstationRequest
) returns ( Workstation
)
Returns the requested workstation.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc GetWorkstationCluster(
GetWorkstationClusterRequest
) returns ( WorkstationCluster
)
Returns the requested workstation cluster.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc GetWorkstationConfig(
GetWorkstationConfigRequest
) returns ( WorkstationConfig
)
Returns the requested workstation configuration.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc ListUsableWorkstationConfigs(
ListUsableWorkstationConfigsRequest
) returns ( ListUsableWorkstationConfigsResponse
)
Returns all workstation configurations in the specified cluster on which the caller has the "workstations.workstation.create" permission.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc ListUsableWorkstations(
ListUsableWorkstationsRequest
) returns ( ListUsableWorkstationsResponse
)
Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc ListWorkstationClusters(
ListWorkstationClustersRequest
) returns ( ListWorkstationClustersResponse
)
Returns all workstation clusters in the specified location.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc ListWorkstationConfigs(
ListWorkstationConfigsRequest
) returns ( ListWorkstationConfigsResponse
)
Returns all workstation configurations in the specified cluster.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc ListWorkstations(
ListWorkstationsRequest
) returns ( ListWorkstationsResponse
)
Returns all Workstations using the specified workstation configuration.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc StartWorkstation(
StartWorkstationRequest
) returns ( Operation
)
Starts running a workstation so that users can connect to it.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc StopWorkstation(
StopWorkstationRequest
) returns ( Operation
)
Stops running a workstation, reducing costs.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc UpdateWorkstation(
UpdateWorkstationRequest
) returns ( Operation
)
Updates an existing workstation.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc UpdateWorkstationCluster(
UpdateWorkstationClusterRequest
) returns ( Operation
)
Updates an existing workstation cluster.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc UpdateWorkstationConfig(
UpdateWorkstationConfigRequest
) returns ( Operation
)
Updates an existing workstation configuration.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
CreateWorkstationClusterRequest
Message for creating a CreateWorkstationCluster.
| Fields | |
|---|---|
parent
|
Required. Parent resource name. |
workstation_cluster_id
|
Required. ID to use for the workstation cluster. |
workstation_cluster
|
Required. Workstation cluster to create. |
validate_only
|
Optional. If set, validate the request and preview the review, but do not actually apply it. |
CreateWorkstationConfigRequest
Message for creating a CreateWorkstationConfig.
| Fields | |
|---|---|
parent
|
Required. Parent resource name. |
workstation_config_id
|
Required. ID to use for the workstation configuration. |
workstation_config
|
Required. Workstation configuration to create. |
validate_only
|
Optional. If set, validate the request and preview the review, but do not actually apply it. |
CreateWorkstationRequest
Message for creating a CreateWorkstation.
| Fields | |
|---|---|
parent
|
Required. Parent resource name. |
workstation_id
|
Required. ID to use for the workstation. |
workstation
|
Required. Workstation to create. If source_workstation is specified, the user must have |
validate_only
|
Optional. If set, validate the request and preview the review, but do not actually apply it. |
DeleteWorkstationClusterRequest
Message for deleting a workstation cluster.
| Fields | |
|---|---|
name
|
Required. Name of the workstation cluster to delete. |
validate_only
|
Optional. If set, validate the request and preview the review, but do not apply it. |
etag
|
Optional. If set, the request will be rejected if the latest version of the workstation cluster on the server does not have this ETag. |
force
|
Optional. If set, any workstation configurations and workstations in the workstation cluster are also deleted. Otherwise, the request only works if the workstation cluster has no configurations or workstations. |
DeleteWorkstationConfigRequest
Message for deleting a workstation configuration.
| Fields | |
|---|---|
name
|
Required. Name of the workstation configuration to delete. |
validate_only
|
Optional. If set, validate the request and preview the review, but do not actually apply it. |
etag
|
Optional. If set, the request is rejected if the latest version of the workstation configuration on the server does not have this ETag. |
force
|
Optional. If set, any workstations in the workstation configuration are also deleted. Otherwise, the request works only if the workstation configuration has no workstations. |
DeleteWorkstationRequest
Request message for DeleteWorkstation.
| Fields | |
|---|---|
name
|
Required. Name of the workstation to delete. |
validate_only
|
Optional. If set, validate the request and preview the review, but do not actually apply it. |
etag
|
Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. |
GenerateAccessTokenRequest
Request message for GenerateAccessToken.
workstation
string
Required. Name of the workstation for which the access token should be generated.
port
int32
Optional. Port for which the access token should be generated. If specified, the generated access token grants access only to the specified port of the workstation. If specified, values must be within the range [1 - 65535]. If not specified, the generated access token grants access to all ports of the workstation.
expiration
. Desired expiration or lifetime of the access token. expiration
can be only one of the following:expire_time
Desired expiration time of the access token. This value must be at most 24 hours in the future. If a value is not specified, the token's expiration time will be set to a default value of 1 hour in the future.
ttl
Desired lifetime duration of the access token. This value must be at most 24 hours. If a value is not specified, the token's lifetime will be set to a default value of 1 hour.
GenerateAccessTokenResponse
Response message for GenerateAccessToken.
| Fields | |
|---|---|
access_token
|
The generated bearer access token. To use this token, include it in an Authorization header of an HTTP request sent to the associated workstation's hostname—for example, |
expire_time
|
Time at which the generated token will expire. |
GetWorkstationClusterRequest
Request message for GetWorkstationCluster.
| Fields | |
|---|---|
name
|
Required. Name of the requested resource. |
GetWorkstationConfigRequest
Request message for GetWorkstationConfig.
| Fields | |
|---|---|
name
|
Required. Name of the requested resource. |
GetWorkstationRequest
Request message for GetWorkstation.
| Fields | |
|---|---|
name
|
Required. Name of the requested resource. |
ListUsableWorkstationConfigsRequest
Request message for ListUsableWorkstationConfigs.
| Fields | |
|---|---|
parent
|
Required. Parent resource name. |
page_size
|
Optional. Maximum number of items to return. |
page_token
|
Optional. next_page_token value returned from a previous List request, if any. |
ListUsableWorkstationConfigsResponse
Response message for ListUsableWorkstationConfigs.
| Fields | |
|---|---|
workstation_configs[]
|
The requested configs. |
next_page_token
|
Token to retrieve the next page of results, or empty if there are no more results in the list. |
unreachable[]
|
Unreachable resources. |
ListUsableWorkstationsRequest
Request message for ListUsableWorkstations.
| Fields | |
|---|---|
parent
|
Required. Parent resource name. |
page_size
|
Optional. Maximum number of items to return. |
page_token
|
Optional. next_page_token value returned from a previous List request, if any. |
ListUsableWorkstationsResponse
Response message for ListUsableWorkstations.
| Fields | |
|---|---|
workstations[]
|
The requested workstations. |
next_page_token
|
Token to retrieve the next page of results, or empty if there are no more results in the list. |
unreachable[]
|
Unreachable resources. |
ListWorkstationClustersRequest
Request message for ListWorkstationClusters.
| Fields | |
|---|---|
parent
|
Required. Parent resource name. |
page_size
|
Optional. Maximum number of items to return. |
page_token
|
Optional. next_page_token value returned from a previous List request, if any. |
filter
|
Optional. Filter the WorkstationClusters to be listed. Possible filters are described in https://google.aip.dev/160 . |
ListWorkstationClustersResponse
Response message for ListWorkstationClusters.
| Fields | |
|---|---|
workstation_clusters[]
|
The requested workstation clusters. |
next_page_token
|
Token to retrieve the next page of results, or empty if there are no more results in the list. |
unreachable[]
|
Unreachable resources. |
ListWorkstationConfigsRequest
Request message for ListWorkstationConfigs.
| Fields | |
|---|---|
parent
|
Required. Parent resource name. |
page_size
|
Optional. Maximum number of items to return. |
page_token
|
Optional. next_page_token value returned from a previous List request, if any. |
filter
|
Optional. Filter the WorkstationConfigs to be listed. Possible filters are described in https://google.aip.dev/160 . |
ListWorkstationConfigsResponse
Response message for ListWorkstationConfigs.
| Fields | |
|---|---|
workstation_configs[]
|
The requested configs. |
next_page_token
|
Token to retrieve the next page of results, or empty if there are no more results in the list. |
unreachable[]
|
Unreachable resources. |
ListWorkstationsRequest
Request message for ListWorkstations.
| Fields | |
|---|---|
parent
|
Required. Parent resource name. |
page_size
|
Optional. Maximum number of items to return. |
page_token
|
Optional. next_page_token value returned from a previous List request, if any. |
filter
|
Optional. Filter the Workstations to be listed. Possible filters are described in https://google.aip.dev/160 . |
ListWorkstationsResponse
Response message for ListWorkstations.
| Fields | |
|---|---|
workstations[]
|
The requested workstations. |
next_page_token
|
Optional. Token to retrieve the next page of results, or empty if there are no more results in the list. |
unreachable[]
|
Optional. Unreachable resources. |
OperationMetadata
Metadata for long-running operations.
| Fields | |
|---|---|
create_time
|
Output only. Time that the operation was created. |
end_time
|
Output only. Time that the operation finished running. |
target
|
Output only. Server-defined resource path for the target of the operation. |
verb
|
Output only. Name of the verb executed by the operation. |
status_message
|
Output only. Human-readable status of the operation, if any. |
requested_cancellation
|
Output only. Identifies whether the user has requested cancellation of the operation. |
api_version
|
Output only. API version used to start the operation. |
StartWorkstationRequest
Request message for StartWorkstation.
| Fields | |
|---|---|
name
|
Required. Name of the workstation to start. |
validate_only
|
Optional. If set, validate the request and preview the review, but do not actually apply it. |
etag
|
Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. |
boost_config
|
Optional. If set, the workstation starts using the boost configuration with the specified ID. |
StopWorkstationRequest
Request message for StopWorkstation.
| Fields | |
|---|---|
name
|
Required. Name of the workstation to stop. |
validate_only
|
Optional. If set, validate the request and preview the review, but do not actually apply it. |
etag
|
Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag. |
UpdateWorkstationClusterRequest
Request message for UpdateWorkstationCluster.
| Fields | |
|---|---|
workstation_cluster
|
Required. Workstation cluster to update. |
update_mask
|
Required. Mask that specifies which fields in the workstation cluster should be updated. |
validate_only
|
Optional. If set, validate the request and preview the review, but do not actually apply it. |
allow_missing
|
Optional. If set, and the workstation cluster is not found, a new workstation cluster will be created. In this situation, update_mask is ignored. |
UpdateWorkstationConfigRequest
Request message for UpdateWorkstationConfig.
| Fields | |
|---|---|
workstation_config
|
Required. Workstation configuration to update. |
update_mask
|
Required. Mask specifying which fields in the workstation configuration should be updated. |
validate_only
|
Optional. If set, validate the request and preview the review, but do not actually apply it. |
allow_missing
|
Optional. If set and the workstation configuration is not found, a new workstation configuration will be created. In this situation, update_mask is ignored. |
UpdateWorkstationRequest
Request message for UpdateWorkstation.
| Fields | |
|---|---|
workstation
|
Required. Workstation to update. |
update_mask
|
Required. Mask specifying which fields in the workstation configuration should be updated. |
validate_only
|
Optional. If set, validate the request and preview the review, but do not actually apply it. |
allow_missing
|
Optional. If set and the workstation configuration is not found, a new workstation configuration is created. In this situation, update_mask is ignored. |
Workstation
A single instance of a developer workstation with its own persistent storage.
| Fields | |
|---|---|
name
|
Identifier. Full name of this workstation. |
display_name
|
Optional. Human-readable name for this workstation. |
uid
|
Output only. A system-assigned unique identifier for this workstation. |
reconciling
|
Output only. Indicates whether this workstation is currently being updated to match its intended state. |
annotations
|
Optional. Client-specified annotations. |
labels
|
Optional. Labels that are applied to the workstation and that are also propagated to the underlying Compute Engine resources. |
create_time
|
Output only. Time when this workstation was created. |
update_time
|
Output only. Time when this workstation was most recently updated. |
start_time
|
Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state. |
delete_time
|
Output only. Time when this workstation was soft-deleted. |
etag
|
Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. |
state
|
Output only. Current state of the workstation. |
host
|
Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format |
env
|
Optional. Environment variables passed to the workstation container's entrypoint. |
kms_key
|
Output only. The name of the Google Cloud KMS encryption key used to encrypt this workstation. The KMS key can only be configured in the WorkstationConfig. The expected format is |
source_workstation
|
Optional. The source workstation from which this workstation's persistent directories were cloned on creation. |
runtime_host
|
Optional. Output only. Runtime host for the workstation when in STATE_RUNNING. |
RuntimeHost
Runtime host for the workstation.
host_type
. Type of host used by the workstation. host_type
can be only one of the following:gce_instance_host
Specifies a Compute Engine instance as the host.
GceInstanceHost
The Compute Engine instance host.
| Fields | |
|---|---|
name
|
Optional. Output only. The name of the Compute Engine instance. |
id
|
Optional. Output only. The ID of the Compute Engine instance. |
zone
|
Optional. Output only. The zone of the Compute Engine instance. |
State
Whether a workstation is running and ready to receive user requests.
| Enums | |
|---|---|
STATE_UNSPECIFIED
|
Do not use. |
STATE_STARTING
|
The workstation is not yet ready to accept requests from users but will be soon. |
STATE_RUNNING
|
The workstation is ready to accept requests from users. |
STATE_STOPPING
|
The workstation is being stopped. |
STATE_STOPPED
|
The workstation is stopped and will not be able to receive requests until it is started. |
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.
| Fields | |
|---|---|
name
|
Identifier. Full name of this workstation cluster. |
display_name
|
Optional. Human-readable name for this workstation cluster. |
uid
|
Output only. A system-assigned unique identifier for this workstation cluster. |
reconciling
|
Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. |
annotations
|
Optional. Client-specified annotations. |
labels
|
Optional. Labels that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. |
create_time
|
Output only. Time when this workstation cluster was created. |
update_time
|
Output only. Time when this workstation cluster was most recently updated. |
delete_time
|
Output only. Time when this workstation cluster was soft-deleted. |
etag
|
Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. |
network
|
Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. |
subnetwork
|
Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. |
control_plane_ip
|
Output only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address. |
private_cluster_config
|
Optional. Configuration for private workstation cluster. |
domain_config
|
Optional. Configuration options for a custom domain. |
degraded
|
Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. The |
conditions[]
|
Output only. Status conditions describing the workstation cluster's current state. |
tags
|
Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" |
gateway_config
|
Optional. Configuration options for Cluster HTTP Gateway. |
DomainConfig
Configuration options for a custom domain.
| Fields | |
|---|---|
domain
|
Immutable. Domain used by Workstations for HTTP ingress. |
GatewayConfig
Configuration options for Cluster HTTP Gateway.
| Fields | |
|---|---|
http2_enabled
|
Optional. Whether HTTP/2 is enabled for this workstation cluster. Defaults to false. |
PrivateClusterConfig
Configuration options for private workstation clusters.
| Fields | |
|---|---|
enable_private_endpoint
|
Immutable. Whether Workstations endpoint is private. |
cluster_hostname
|
Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. |
service_attachment_uri
|
Output only. Service attachment URI for the workstation cluster. The service attachment is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using Private Service Connect . |
allowed_projects[]
|
Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. |
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) rules to grant access to teams or to individual developers.
name
string
Identifier. Full name of this workstation configuration.
display_name
string
Optional. Human-readable name for this workstation configuration.
uid
string
Output only. A system-assigned unique identifier for this workstation configuration.
reconciling
bool
Output only. Indicates whether this workstation configuration is currently being updated to match its intended state.
annotations
map<string, string>
Optional. Client-specified annotations.
labels
map<string, string>
Optional. Labels that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.
create_time
Output only. Time when this workstation configuration was created.
update_time
Output only. Time when this workstation configuration was most recently updated.
delete_time
Output only. Time when this workstation configuration was soft-deleted.
etag
string
Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
idle_timeout
Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic.
A value of "0s"
indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide duration
terminated by s
for seconds—for example, "7200s"
(2 hours). The default is "1200s"
(20 minutes).
running_timeout
Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout
and running_timeout
fields are independent of each other. Note that the running_timeout
field shuts down VMs after the specified time, regardless of whether or not the VMs are idle.
Provide duration terminated by s
for seconds—for example, "54000s"
(15 hours). Defaults to "43200s"
(12 hours). A value of "0s"
indicates that workstations using this configuration should never time out. If encryption_key
is set, it must be greater than "0s"
and less than "86400s"
(24 hours).
Warning: A value of "0s"
indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.
max_usable_workstations
int32
Optional. Maximum number of workstations under this configuration a user can have workstations.workstation.use
permission on.
Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by:
- granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or
- having a user with that permission create a workstation and granting another user
workstations.workstation.usepermission on that workstation.
If not specified, defaults to 0
, which indicates unlimited.
host
Optional. Runtime host for the workstation.
persistent_directories[]
Optional. Directories to persist across workstation sessions.
ephemeral_directories[]
Optional. Ephemeral directories which won't persist across workstation sessions.
container
Optional. Container that runs upon startup for each workstation using this workstation configuration.
encryption_key
Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK).
If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata.
If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost.
If the encryption key is revoked, the workstation session automatically stops within 7 hours.
Immutable after the workstation configuration is created.
readiness_checks[]
Optional. Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes.
replica_zones[]
string
Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, ['us-central1-a', 'us-central1-f']
. If this field is empty, two default zones within the region are used.
Immutable after the workstation configuration is created.
degraded
bool
Output only. Whether this workstation configuration is in degraded mode, in which case it may require user action to restore full functionality. The conditions
field contains detailed information about the status of the configuration.
conditions[]
Output only. Status conditions describing the workstation configuration's current state.
enable_audit_agent
bool
Optional. Whether to enable Linux auditd
logging on the workstation. When enabled, a service_account
must also be specified that has roles/logging.logWriter
and roles/monitoring.metricWriter
on the project. Operating system audit logging is distinct from Cloud Audit Logs
and Container output logging
. Operating system audit logs are available in the Cloud Logging
console by querying:
resource.type="gce_instance"
log_name:"/logs/linux-auditd"
disable_tcp_connections
bool
Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS.
allowed_ports[]
grant_workstation_admin_role_on_create
bool
Optional. Grant creator of a workstation roles/workstations.policyAdmin
role along with roles/workstations.user
role on the workstation created by them. This allows workstation users to share access to either their entire workstation, or individual ports. Defaults to false.
Container
A Docker container.
| Fields | |
|---|---|
image
|
Optional. A Docker container image that defines a custom environment. Cloud Workstations provides a number of preconfigured images
, but you can create your own custom container images
. If using a private image, the |
command[]
|
Optional. If set, overrides the default ENTRYPOINT specified by the image. |
args[]
|
Optional. Arguments passed to the entrypoint. |
env
|
Optional. Environment variables passed to the container's entrypoint. |
working_dir
|
Optional. If set, overrides the default DIR specified by the image. |
run_as_user
|
Optional. If set, overrides the USER specified in the image with the given uid. |
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 .
| Fields | |
|---|---|
kms_key
|
Immutable. The name of the Google Cloud KMS encryption key. For example, |
kms_key_service_account
|
Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see Separation of duties
and |
EphemeralDirectory
An ephemeral directory which won't persist across workstation sessions. It is freshly created on every workstation start operation.
mount_path
string
Required. Location of this directory in the running workstation.
directory_type
. How an ephemeral directory should be implemented. directory_type
can be only one of the following:gce_pd
An EphemeralDirectory backed by a Compute Engine persistent disk.
GcePersistentDisk
An EphemeralDirectory is backed by a Compute Engine persistent disk.
| Fields | |
|---|---|
disk_type
|
Optional. Type of the disk to use. Defaults to |
source_snapshot
|
Optional. Name of the snapshot to use as the source for the disk. Must be empty if Only file systems supported by Container-Optimized OS (COS) are explicitly supported. For a list of supported file systems, see the filesystems available in Container-Optimized OS . This field is mutable. |
source_image
|
Optional. Name of the disk image to use as the source for the disk. Must be empty if Only file systems supported by Container-Optimized OS (COS) are explicitly supported. For a list of supported file systems, please refer to the COS documentation . This field is mutable. |
read_only
|
Optional. Whether the disk is read only. If true, the disk may be shared by multiple VMs and |
Host
Runtime host for a workstation.
config
. Type of host to be used for the workstation's runtime. config
can be only one of the following:gce_instance
Specifies a Compute Engine instance as the host.
GceInstance
A runtime using a Compute Engine instance.
machine_type
string
Optional. The type of machine to use for VM instances—for example, "e2-standard-4"
. For more information about machine types that Cloud Workstations supports, see the list of available machine types
.
service_account
string
Optional. The email address of the service account for Cloud Workstations VMs created with this configuration. When specified, be sure that the service account has logging.logEntries.create
and monitoring.timeSeries.create
permissions on the project so it can write logs out to Cloud Logging. If using a custom container image, the service account must have Artifact Registry Reader
permission to pull the specified image.
If you as the administrator want to be able to ssh
into the underlying VM, you need to set this value to a service account for which you have the iam.serviceAccounts.actAs
permission. Conversely, if you don't want anyone to be able to ssh
into the underlying VM, use a service account where no one has that permission.
If not set, VMs run with a service account provided by the Cloud Workstations service, and the image must be publicly accessible.
service_account_scopes[]
string
Optional. Scopes to grant to the service_account
. When specified, users of workstations under this configuration must have iam.serviceAccounts.actAs
on the service account.
pool_size
int32
Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to 0
in the API.
pooled_instances
int32
Output only. Number of instances currently available in the pool for faster workstation startup.
disable_public_ip_addresses
bool
Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use private.googleapis.com
or restricted.googleapis.com
for Container Registry and Artifact Registry, make sure that you set up DNS records for domains *.gcr.io
and *.pkg.dev
. Defaults to false (VMs have public IP addresses).
enable_nested_virtualization
bool
Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration.
Defaults to false.
Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the same restrictions as Compute Engine instances :
- Organization policy: projects, folders, or organizations may be restricted from creating nested VMs if the Disable VM nested virtualizationconstraint is enforced in the organization policy. For more information, see the Compute Engine section, Checking whether nested virtualization is allowed .
- Performance: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound.
- Machine Type: nested virtualization can only be enabled on workstation configurations that specify a
machine_typein the N1 or N2 machine series.
shielded_instance_config
Optional. A set of Compute Engine Shielded instance options.
confidential_instance_config
Optional. A set of Compute Engine Confidential VM instance options.
boot_disk_size_gb
int32
Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is 30
GB. Defaults to 50
GB.
accelerators[]
Optional. A list of the type and count of accelerator cards attached to the instance.
boost_configs[]
Optional. A list of the boost configurations that workstations created using this workstation configuration are allowed to use. If specified, users will have the option to choose from the list of boost configs when starting a workstation.
disable_ssh
bool
Optional. Whether to disable SSH access to the VM.
Accelerator
An accelerator card attached to the instance.
| Fields | |
|---|---|
type
|
Optional. Type of accelerator resource to attach to the instance, for example, |
count
|
Optional. Number of accelerator cards exposed to the instance. |
BoostConfig
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.
id
string
Required. The ID to be used for the boost configuration.
machine_type
string
Optional. The type of machine that boosted VM instances will use—for example, e2-standard-4
. For more information about machine types that Cloud Workstations supports, see the list of available machine types
. Defaults to e2-standard-4
.
accelerators[]
Optional. A list of the type and count of accelerator cards attached to the boost instance. Defaults to none
.
boot_disk_size_gb
int32
Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is 30
GB. Defaults to 50
GB.
enable_nested_virtualization
bool
Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration.
Defaults to false.
Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the same restrictions as Compute Engine instances :
- Organization policy: projects, folders, or organizations may be restricted from creating nested VMs if the Disable VM nested virtualizationconstraint is enforced in the organization policy. For more information, see the Compute Engine section, Checking whether nested virtualization is allowed .
- Performance: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound.
- Machine Type: nested virtualization can only be enabled on boost configurations that specify a
machine_typein the N1 or N2 machine series.
pool_size
int32
Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to 0
.
GceConfidentialInstanceConfig
A set of Compute Engine Confidential VM instance options.
| Fields | |
|---|---|
enable_confidential_compute
|
Optional. Whether the instance has confidential compute enabled. |
GceShieldedInstanceConfig
A set of Compute Engine Shielded instance options.
| Fields | |
|---|---|
enable_secure_boot
|
Optional. Whether the instance has Secure Boot enabled. |
enable_vtpm
|
Optional. Whether the instance has the vTPM enabled. |
enable_integrity_monitoring
|
Optional. Whether the instance has integrity monitoring enabled. |
PersistentDirectory
A directory to persist across workstation sessions. Updates to this field will not update existing workstations and will only take effect on new workstations.
mount_path
string
Optional. Location of this directory in the running workstation.
directory_type
. How a persistent directory should be implemented. directory_type
can be only one of the following:gce_pd
A PersistentDirectory backed by a Compute Engine persistent disk.
GceRegionalPersistentDisk
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
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.
| Fields | |
|---|---|
size_gb
|
Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if Valid values are |
fs_type
|
Optional. Type of file system that the disk should be formatted with. The workstation image must support this file system type. Must be empty if |
disk_type
|
Optional. The type of the persistent disk
for the home directory. Defaults to |
source_snapshot
|
Optional. Name of the snapshot to use as the source for the disk. If set, |
reclaim_policy
|
Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are |
ReclaimPolicy
Value representing what should happen to the disk after the workstation is deleted.
| Enums | |
|---|---|
RECLAIM_POLICY_UNSPECIFIED
|
Do not use. |
DELETE
|
Delete the persistent disk when deleting the workstation. |
RETAIN
|
Keep the persistent disk when deleting the workstation. An administrator must manually delete the disk. |
PortRange
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.
| Fields | |
|---|---|
first
|
Required. Starting port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535. |
last
|
Required. Ending port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535. |
ReadinessCheck
A readiness check to be performed on a workstation.
| Fields | |
|---|---|
path
|
Optional. Path to which the request should be sent. |
port
|
Optional. Port to which the request should be sent. |
