workstation_clusters

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

Overview

Name	workstation_clusters
Type	Resource
Id	google.workstations.workstation_clusters

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. Full name of this workstation cluster.
annotations	object	Optional. Client-specified annotations.
conditions	array	Output only. Status conditions describing the workstation cluster's current state.
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.
createTime	string (google-datetime)	Output only. Time when this workstation cluster was created.
degraded	boolean	Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the cluster.
deleteTime	string (google-datetime)	Output only. Time when this workstation cluster was soft-deleted.
displayName	string	Optional. Human-readable name for this workstation cluster.
domainConfig	object	Optional. Configuration options for a custom domain. (id: DomainConfig)
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.
gatewayConfig	object	Optional. Configuration options for Cluster HTTP Gateway. (id: GatewayConfig)
labels	object	Optional. Labels that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.
network	string	Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.
privateClusterConfig	object	Optional. Configuration for private workstation cluster. (id: PrivateClusterConfig)
reconciling	boolean	Output only. Indicates whether this workstation cluster is currently being updated to match its intended state.
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.
tags	object	Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
uid	string	Output only. A system-assigned unique identifier for this workstation cluster.
updateTime	string (google-datetime)	Output only. Time when this workstation cluster was most recently updated.

list

Successful response

Name	Datatype	Description
name	string	Identifier. Full name of this workstation cluster.
annotations	object	Optional. Client-specified annotations.
conditions	array	Output only. Status conditions describing the workstation cluster's current state.
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.
createTime	string (google-datetime)	Output only. Time when this workstation cluster was created.
degraded	boolean	Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the cluster.
deleteTime	string (google-datetime)	Output only. Time when this workstation cluster was soft-deleted.
displayName	string	Optional. Human-readable name for this workstation cluster.
domainConfig	object	Optional. Configuration options for a custom domain. (id: DomainConfig)
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.
gatewayConfig	object	Optional. Configuration options for Cluster HTTP Gateway. (id: GatewayConfig)
labels	object	Optional. Labels that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.
network	string	Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.
privateClusterConfig	object	Optional. Configuration for private workstation cluster. (id: PrivateClusterConfig)
reconciling	boolean	Output only. Indicates whether this workstation cluster is currently being updated to match its intended state.
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.
tags	object	Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
uid	string	Output only. A system-assigned unique identifier for this workstation cluster.
updateTime	string (google-datetime)	Output only. Time when this workstation cluster was most recently updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, workstationClustersId		Returns the requested workstation cluster.
list	select	projectsId, locationsId	pageSize, pageToken, filter	Returns all workstation clusters in the specified location.
create	insert	projectsId, locationsId	workstationClusterId, validateOnly	Creates a new workstation cluster.
patch	update	projectsId, locationsId, workstationClustersId	updateMask, validateOnly, allowMissing	Updates an existing workstation cluster.
delete	delete	projectsId, locationsId, workstationClustersId	validateOnly, etag, force	Deletes the specified workstation cluster.

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
allowMissing	boolean
etag	string
filter	string
force	boolean
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
validateOnly	boolean
workstationClusterId	string

SELECT examples

get

Returns the requested workstation cluster.

SELECT
name,
annotations,
conditions,
controlPlaneIp,
createTime,
degraded,
deleteTime,
displayName,
domainConfig,
etag,
gatewayConfig,
labels,
network,
privateClusterConfig,
reconciling,
subnetwork,
tags,
uid,
updateTime
FROM google.workstations.workstation_clusters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND workstationClustersId = '{{ workstationClustersId }}' -- required;

list

Returns all workstation clusters in the specified location.

SELECT
name,
annotations,
conditions,
controlPlaneIp,
createTime,
degraded,
deleteTime,
displayName,
domainConfig,
etag,
gatewayConfig,
labels,
network,
privateClusterConfig,
reconciling,
subnetwork,
tags,
uid,
updateTime
FROM google.workstations.workstation_clusters
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

INSERT examples

create

Creates a new workstation cluster.

INSERT INTO google.workstations.workstation_clusters (
data__name,
data__displayName,
data__annotations,
data__labels,
data__etag,
data__network,
data__subnetwork,
data__privateClusterConfig,
data__domainConfig,
data__tags,
data__gatewayConfig,
projectsId,
locationsId,
workstationClusterId,
validateOnly
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ annotations }}',
'{{ labels }}',
'{{ etag }}',
'{{ network }}',
'{{ subnetwork }}',
'{{ privateClusterConfig }}',
'{{ domainConfig }}',
'{{ tags }}',
'{{ gatewayConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ workstationClusterId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: workstation_clusters
  props:
    - name: projectsId
      value: string
      description: Required parameter for the workstation_clusters resource.
    - name: locationsId
      value: string
      description: Required parameter for the workstation_clusters resource.
    - name: name
      value: string
      description: >
        Identifier. Full name of this workstation cluster.
        
    - name: displayName
      value: string
      description: >
        Optional. Human-readable name for this workstation cluster.
        
    - name: annotations
      value: object
      description: >
        Optional. Client-specified annotations.
        
    - name: labels
      value: object
      description: >
        Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources.
        
    - name: etag
      value: string
      description: >
        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.
        
    - name: network
      value: string
      description: >
        Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.
        
    - name: subnetwork
      value: string
      description: >
        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.
        
    - name: privateClusterConfig
      value: object
      description: >
        Optional. Configuration for private workstation cluster.
        
    - name: domainConfig
      value: object
      description: >
        Optional. Configuration options for a custom domain.
        
    - name: tags
      value: object
      description: >
        Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
        
    - name: gatewayConfig
      value: object
      description: >
        Optional. Configuration options for Cluster HTTP Gateway.
        
    - name: workstationClusterId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

patch

Updates an existing workstation cluster.

UPDATE google.workstations.workstation_clusters
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__annotations = '{{ annotations }}',
data__labels = '{{ labels }}',
data__etag = '{{ etag }}',
data__network = '{{ network }}',
data__subnetwork = '{{ subnetwork }}',
data__privateClusterConfig = '{{ privateClusterConfig }}',
data__domainConfig = '{{ domainConfig }}',
data__tags = '{{ tags }}',
data__gatewayConfig = '{{ gatewayConfig }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND workstationClustersId = '{{ workstationClustersId }}' --required
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
AND allowMissing = {{ allowMissing}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes the specified workstation cluster.

DELETE FROM google.workstations.workstation_clusters
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND workstationClustersId = '{{ workstationClustersId }}' --required
AND validateOnly = '{{ validateOnly }}'
AND etag = '{{ etag }}'
AND force = '{{ force }}';