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}
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 ignores the request if it has already been completed. The server guarantees 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 the original operation with the same request ID was received, and if so, ignores 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, for example, permission checks and any other type of validation, but does not actually execute the create 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-15 UTC."],[[["\u003cp\u003eThis endpoint updates the parameters of a single Cluster resource via a PATCH request to the specified URL.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eupdateMask\u003c/code\u003e parameter allows you to selectively overwrite specific fields within the Cluster resource, or if it's absent, all fields will be overwritten.\u003c/p\u003e\n"],["\u003cp\u003eAn optional \u003ccode\u003erequestId\u003c/code\u003e parameter can be provided to help manage request retries and prevent duplicate operations.\u003c/p\u003e\n"],["\u003cp\u003eIf the \u003ccode\u003eallowMissing\u003c/code\u003e parameter is set to true, the update will proceed even if the cluster is not found, creating a new cluster in its place.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful updates return an \u003ccode\u003eOperation\u003c/code\u003e resource, and authorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.clusters.patch\n\nUpdates the parameters of a single Cluster.\n\n### HTTP request\n\n`PATCH https://alloydb.googleapis.com/v1beta/{cluster.name=projects/*/locations/*/clusters/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body contains an instance of [Cluster](/alloydb/docs/reference/rest/v1beta/projects.locations.clusters#Cluster).\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/alloydb/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
