Resource: Workstation
A single instance of a developer workstation with its own persistent storage.
JSON representation |
---|
{
"name": string,
"displayName": string,
"uid": string,
"reconciling": boolean,
"annotations": {
string: string,
...
},
"labels": {
string: string,
...
},
"createTime": string,
"updateTime": string,
"startTime": string,
"deleteTime": string,
"etag": string,
"state": enum ( |
Fields | |
---|---|
name |
Identifier. Full name of this workstation. |
display |
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. An object containing a list of |
labels |
Optional. Labels that are applied to the workstation and that are also propagated to the underlying Compute Engine resources. An object containing a list of |
create |
Output only. Time when this workstation was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
update |
Output only. Time when this workstation was most recently updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
start |
Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
delete |
Output only. Time when this workstation was soft-deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
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. An object containing a list of |
kms |
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 |
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. |
Methods |
|
---|---|
|
Creates a new workstation. |
|
Deletes the specified workstation. |
|
Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation. |
|
Returns the requested workstation. |
|
Gets the access control policy for a resource. |
|
Returns all Workstations using the specified workstation configuration. |
|
Returns all workstations using the specified workstation configuration on which the caller has the "workstations.workstations.use" permission. |
|
Updates an existing workstation. |
|
Sets the access control policy on the specified resource. |
|
Starts running a workstation so that users can connect to it. |
|
Stops running a workstation, reducing costs. |
|
Returns permissions that a caller has on the specified resource. |