Optional. Field mask is used to specify the fields to be overwritten in the Cluster resource by the update. The fields specified in the update_mask 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.
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).
↳ validate_only
bool
Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
↳ allow_missing
bool
Optional. If set to true, update succeeds even if cluster is not found. In that case, a new cluster is created andupdate_maskis ignored.
getUpdateMask
Optional. Field mask is used to specify the fields to be overwritten in the
Cluster resource by the update.
The fields specified in the update_mask 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.
Optional. Field mask is used to specify the fields to be overwritten in the
Cluster resource by the update.
The fields specified in the update_mask 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.
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).
Returns
Type
Description
string
setRequestId
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).
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getValidateOnly
Optional. If set, performs request validation, for example, permission
checks and any other type of validation, but does not actually execute the
create request.
Returns
Type
Description
bool
setValidateOnly
Optional. If set, performs request validation, for example, permission
checks and any other type of validation, but does not actually execute the
create request.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getAllowMissing
Optional. If set to true, update succeeds even if cluster is not found. In
that case, a new cluster is created andupdate_maskis ignored.
Returns
Type
Description
bool
setAllowMissing
Optional. If set to true, update succeeds even if cluster is not found. In
that case, a new cluster is created andupdate_maskis ignored.
Optional. Field mask is used to specify the fields to be overwritten in the
Cluster resource by the update.
The fields specified in the update_mask 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.
[[["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-09-04 UTC."],[],[],null,["# Google Cloud AlloyDB for PostgreSQL V1 Client - Class UpdateClusterRequest (1.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.1 (latest)](/php/docs/reference/cloud-alloydb/latest/V1.UpdateClusterRequest)\n- [1.4.0](/php/docs/reference/cloud-alloydb/1.4.0/V1.UpdateClusterRequest)\n- [1.3.0](/php/docs/reference/cloud-alloydb/1.3.0/V1.UpdateClusterRequest)\n- [1.2.0](/php/docs/reference/cloud-alloydb/1.2.0/V1.UpdateClusterRequest)\n- [1.1.3](/php/docs/reference/cloud-alloydb/1.1.3/V1.UpdateClusterRequest)\n- [1.0.0](/php/docs/reference/cloud-alloydb/1.0.0/V1.UpdateClusterRequest)\n- [0.10.3](/php/docs/reference/cloud-alloydb/0.10.3/V1.UpdateClusterRequest)\n- [0.9.0](/php/docs/reference/cloud-alloydb/0.9.0/V1.UpdateClusterRequest)\n- [0.8.0](/php/docs/reference/cloud-alloydb/0.8.0/V1.UpdateClusterRequest)\n- [0.7.1](/php/docs/reference/cloud-alloydb/0.7.1/V1.UpdateClusterRequest)\n- [0.6.0](/php/docs/reference/cloud-alloydb/0.6.0/V1.UpdateClusterRequest)\n- [0.5.0](/php/docs/reference/cloud-alloydb/0.5.0/V1.UpdateClusterRequest)\n- [0.4.0](/php/docs/reference/cloud-alloydb/0.4.0/V1.UpdateClusterRequest)\n- [0.3.0](/php/docs/reference/cloud-alloydb/0.3.0/V1.UpdateClusterRequest)\n- [0.2.1](/php/docs/reference/cloud-alloydb/0.2.1/V1.UpdateClusterRequest)\n- [0.1.3](/php/docs/reference/cloud-alloydb/0.1.3/V1.UpdateClusterRequest) \nReference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class UpdateClusterRequest.\n\nMessage for updating a Cluster\n\nGenerated from protobuf message `google.cloud.alloydb.v1.UpdateClusterRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AlloyDb \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getUpdateMask\n\nOptional. Field mask is used to specify the fields to be overwritten in the\nCluster resource by the update.\n\nThe fields specified in the update_mask are relative to the resource, not\nthe full request. A field will be overwritten if it is in the mask. If the\nuser does not provide a mask then all fields will be overwritten.\n\n### hasUpdateMask\n\n### clearUpdateMask\n\n### setUpdateMask\n\nOptional. Field mask is used to specify the fields to be overwritten in the\nCluster resource by the update.\n\nThe fields specified in the update_mask are relative to the resource, not\nthe full request. A field will be overwritten if it is in the mask. If the\nuser does not provide a mask then all fields will be overwritten.\n\n### getCluster\n\nRequired. The resource being updated\n\n### hasCluster\n\n### clearCluster\n\n### setCluster\n\nRequired. The resource being updated\n\n### getRequestId\n\nOptional. An optional request ID to identify requests. Specify a unique\nrequest ID so that if you must retry your request, the server ignores the\nrequest if it has already been completed. The server guarantees that for at\nleast 60 minutes since the first request.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same request\nID, the server can check if the original operation with the same request ID\nwas received, and if so, ignores the second request. This prevents\nclients from accidentally creating duplicate commitments.\nThe request ID must be a valid UUID with the exception that zero UUID is\nnot supported (00000000-0000-0000-0000-000000000000).\n\n### setRequestId\n\nOptional. An optional request ID to identify requests. Specify a unique\nrequest ID so that if you must retry your request, the server ignores the\nrequest if it has already been completed. The server guarantees that for at\nleast 60 minutes since the first request.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same request\nID, the server can check if the original operation with the same request ID\nwas received, and if so, ignores the second request. This prevents\nclients from accidentally creating duplicate commitments.\nThe request ID must be a valid UUID with the exception that zero UUID is\nnot supported (00000000-0000-0000-0000-000000000000).\n\n### getValidateOnly\n\nOptional. If set, performs request validation, for example, permission\nchecks and any other type of validation, but does not actually execute the\ncreate request.\n\n### setValidateOnly\n\nOptional. If set, performs request validation, for example, permission\nchecks and any other type of validation, but does not actually execute the\ncreate request.\n\n### getAllowMissing\n\nOptional. If set to true, update succeeds even if cluster is not found. In\nthat case, a new cluster is created and `update_mask` is ignored.\n\n### setAllowMissing\n\nOptional. If set to true, update succeeds even if cluster is not found. In\nthat case, a new cluster is created and `update_mask` is ignored.\n\n### static::build"]]
