workstations_usable

Creates, updates, deletes, gets or lists a workstations_usable resource.

Overview

Name	workstations_usable
Type	Resource
Id	google.workstations.workstations_usable

Fields

The following fields are returned by SELECT queries:

list_usable

Successful response

Name	Datatype	Description
name	string	Identifier. Full name of this workstation.
annotations	object	Optional. Client-specified annotations.
createTime	string (google-datetime)	Output only. Time when this workstation was created.
deleteTime	string (google-datetime)	Output only. Time when this workstation was soft-deleted.
displayName	string	Optional. Human-readable name for this workstation.
env	object	Optional. Environment variables passed to the workstation container's entrypoint.
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.
host	string	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 {port}-{host}.
kmsKey	string	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 projects/*/locations/*/keyRings/*/cryptoKeys/*.
labels	object	Optional. Labels that are applied to the workstation and that are also propagated to the underlying Compute Engine resources.
reconciling	boolean	Output only. Indicates whether this workstation is currently being updated to match its intended state.
runtimeHost	object	Optional. Output only. Runtime host for the workstation when in STATE_RUNNING. (id: RuntimeHost)
sourceWorkstation	string	Optional. The source workstation from which this workstation's persistent directories were cloned on creation.
startTime	string (google-datetime)	Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state.
state	string	Output only. Current state of the workstation.
uid	string	Output only. A system-assigned unique identifier for this workstation.
updateTime	string (google-datetime)	Output only. Time when this workstation was most recently updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_usable	select	projectsId, locationsId, workstationClustersId, workstationConfigsId	pageSize, pageToken	Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
workstationClustersId	string
workstationConfigsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

list_usable

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

SELECT
name,
annotations,
createTime,
deleteTime,
displayName,
env,
etag,
host,
kmsKey,
labels,
reconciling,
runtimeHost,
sourceWorkstation,
startTime,
state,
uid,
updateTime
FROM google.workstations.workstations_usable
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND workstationClustersId = '{{ workstationClustersId }}' -- required
AND workstationConfigsId = '{{ workstationConfigsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';