Method: projects.locations.clusters.patch

Updates the parameters of a single Cluster.

HTTP request

PATCH https://alloydb.googleapis.com/v1beta/{cluster.name=projects/*/locations/*/clusters/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
cluster.name

string

Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{clusterId} where the cluster ID segment should satisfy the regex expression "[a-z0-9-]+". For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. Field mask is used to specify the fields to be overwritten in the Cluster resource by the update. The fields specified in the updateMask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

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

requestId

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

validateOnly

boolean

Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.

allowMissing

boolean

Optional. If set to true, update succeeds even if cluster is not found. In that case, a new cluster is created and updateMask is ignored.

Request body

The request body contains an instance of Cluster.

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.