REST Resource: projects.locations.workstationClusters

Resource: 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.

JSON representation 
{
  "name": string,
  "displayName": string,
  "uid": string,
  "reconciling": boolean,
  "annotations": {
    string: string,
    ...
  },
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "etag": string,
  "network": string,
  "subnetwork": string,
  "controlPlaneIp": string,
  "privateClusterConfig": {
    object (PrivateClusterConfig)
  },
  "domainConfig": {
    object (DomainConfig)
  },
  "degraded": boolean,
  "conditions": [
    {
      object (Status)
    }
  ],
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean,
  "tags": {
    string: string,
    ...
  }
}
Fields
name

string

Identifier. Full name of this workstation cluster.
displayName

string

Optional. Human-readable name for this workstation cluster.
uid

string

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

boolean

Output only. Indicates whether this workstation cluster 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 cluster 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 cluster was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
deleteTime

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
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.
network

string

Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.
subnetwork

string

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.
controlPlaneIp

string

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.
privateClusterConfig

object (PrivateClusterConfig)

Optional. Configuration for private workstation cluster.
domainConfig

object (DomainConfig)

Optional. Configuration options for a custom domain.
degraded

boolean

Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions.
conditions[]

object (Status)

Output only. Status conditions describing the workstation cluster's current state.
satisfiesPzs

boolean

Output only. Reserved for future use.
satisfiesPzi

boolean

Output only. Reserved for future use.
tags

map (key: string, value: string)

Optional. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"

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

PrivateClusterConfig

Configuration options for private workstation clusters.

JSON representation 
{
  "enablePrivateEndpoint": boolean,
  "clusterHostname": string,
  "serviceAttachmentUri": string,
  "allowedProjects": [
    string
  ]
}
Fields
enablePrivateEndpoint

boolean

Immutable. Whether Workstations endpoint is private.
clusterHostname

string

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.
serviceAttachmentUri

string

Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using Private Service Connect.
allowedProjects[]

string

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.

DomainConfig

Configuration options for a custom domain.

JSON representation 
{
  "domain": string
}
Fields
domain

string

Immutable. Domain used by Workstations for HTTP ingress.

Methods

create

 Creates a new workstation cluster.

delete

 Deletes the specified workstation cluster.

get

 Returns the requested workstation cluster.

list

 Returns all workstation clusters in the specified location.

patch

 Updates an existing workstation cluster.