Method: projects.locations.workstationClusters.patch

Updates an existing workstation cluster.

HTTP request

PATCH https://workstations.googleapis.com/v1beta/{workstationCluster.name=projects/*/locations/*/workstationClusters/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
workstationCluster.name

string

Identifier. Full name of this workstation cluster.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Mask that specifies which fields in the workstation cluster should be updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

validateOnly

boolean

Optional. If set, validate the request and preview the review, but do not actually apply it.

allowMissing

boolean

Optional. If set, and the workstation cluster is not found, a new workstation cluster will be created. In this situation, updateMask is ignored.

Request body

The request body contains an instance of WorkstationCluster.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.