workstations

Overview

Name	workstations
Type	Resource
Id	google.workstations.workstations

Fields

Name	Datatype	Description
name	string	Full name of this workstation.
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.
reconciling	boolean	Output only. Indicates whether this workstation is currently being updated to match its intended state.
uid	string	Output only. A system-assigned unique identifier for this workstation.
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}.
createTime	string	Output only. Time when this workstation was created.
labels	object	Optional. Labels that are applied to the workstation and that are also propagated to the underlying Compute Engine resources.
state	string	Output only. Current state of the workstation.
displayName	string	Optional. Human-readable name for this workstation.
annotations	object	Optional. Client-specified annotations.
env	object	Optional. Environment variables passed to the workstation container's entrypoint.
updateTime	string	Output only. Time when this workstation was most recently updated.
deleteTime	string	Output only. Time when this workstation was soft-deleted.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, projectsId, workstationClustersId, workstationConfigsId, workstationsId	Returns the requested workstation.
list	SELECT	locationsId, projectsId, workstationClustersId, workstationConfigsId	Returns all Workstations using the specified workstation configuration.
create	INSERT	locationsId, projectsId, workstationClustersId, workstationConfigsId	Creates a new workstation.
delete	DELETE	locationsId, projectsId, workstationClustersId, workstationConfigsId, workstationsId	Deletes the specified workstation.
_list	EXEC	locationsId, projectsId, workstationClustersId, workstationConfigsId	Returns all Workstations using the specified workstation configuration.
generate_access_token	EXEC	locationsId, projectsId, workstationClustersId, workstationConfigsId, workstationsId	Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation.
patch	EXEC	locationsId, projectsId, workstationClustersId, workstationConfigsId, workstationsId	Updates an existing workstation.
start	EXEC	locationsId, projectsId, workstationClustersId, workstationConfigsId, workstationsId	Starts running a workstation so that users can connect to it.
stop	EXEC	locationsId, projectsId, workstationClustersId, workstationConfigsId, workstationsId	Stops running a workstation, reducing costs.