REST Resource: projects.locations.workstationClusters.workstationConfigs.workstations

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 (State),
  "host": string,
  "env": {
    string: string,
    ...
  },
  "kmsKey": string,
  "boostConfigs": [
    {
      object (WorkstationBoostConfig)
    }
  ],
  "sourceWorkstation": string,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean,
  "runtimeHost": {
    object (RuntimeHost)
  }
}
Fields
name

string

Identifier. Full name of this workstation.
displayName

string

Optional. Human-readable name for this workstation.
uid

string

Output only. A system-assigned unique identifier for this workstation.
reconciling

boolean

Output only. Indicates whether this workstation is currently being updated to match its intended state.
annotations

map (key: string, value: string)

Optional. Client-specified annotations.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
labels

map (key: string, value: string)

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 "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Output only. Time when this workstation was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Time when this workstation was most recently updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
startTime

string (Timestamp format)

Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
deleteTime

string (Timestamp format)

Output only. Time when this workstation was soft-deleted.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
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.
state

enum (State)

Output only. Current state of the 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}.
env

map (key: string, value: string)

Optional. Environment variables passed to the workstation container's entrypoint.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
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/*.
boostConfigs[]

object (WorkstationBoostConfig)

Output only. List of available boost configuration IDs that this workstation can be boosted up to.
sourceWorkstation

string

Optional. The source workstation from which this workstation's persistent directories were cloned on creation.
satisfiesPzs

boolean

Output only. Reserved for future use.
satisfiesPzi

boolean

Output only. Reserved for future use.
runtimeHost

object (RuntimeHost)

Optional. Output only. Runtime host for the workstation when in STATE_RUNNING.

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.

WorkstationBoostConfig

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

JSON representation 
{
  "id": string
}
Fields
id

string

Output only. Boost configuration ID.

RuntimeHost

Runtime host for the workstation.

JSON representation 
{

  // Union field host_type can be only one of the following:
  "gceInstanceHost": {
    object (GceInstanceHost)
  }
  // End of list of possible types for union field host_type.
}
Fields
Union field host_type. Type of host used by the workstation. host_type can be only one of the following:
gceInstanceHost

object (GceInstanceHost)

Specifies a Compute Engine instance as the host.

GceInstanceHost

The Compute Engine instance host.

JSON representation 
{
  "name": string,
  "id": string,
  "zone": string
}
Fields
name

string

Optional. Output only. The name of the Compute Engine instance.
id

string

Optional. Output only. The ID of the Compute Engine instance.
zone

string

Optional. Output only. The zone of the Compute Engine instance.

Methods

create

 Creates a new workstation.

delete

 Deletes the specified workstation.

generateAccessToken

 Returns a short-lived credential that can be used to send authenticated and authorized traffic to a workstation.

get

 Returns the requested workstation.

getIamPolicy

 Gets the access control policy for a resource.

list

 Returns all Workstations using the specified workstation configuration.

listUsable

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

patch

 Updates an existing workstation.

setIamPolicy

 Sets the access control policy on the specified resource.

start

 Starts running a workstation so that users can connect to it.

stop

 Stops running a workstation, reducing costs.

testIamPermissions

 Returns permissions that a caller has on the specified resource.