Google Cloud AlloyDB for PostgreSQL V1 Client - Class UpdateClusterRequest (1.1.0)

Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class UpdateClusterRequest.

Message for updating a Cluster

Generated from protobuf message google.cloud.alloydb.v1.UpdateClusterRequest

Namespace

Google \ Cloud \ AlloyDb \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ update_mask Google\Protobuf\FieldMask

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.
↳ cluster Google\Cloud\AlloyDb\V1\Cluster

Required. The resource being updated
↳ request_id 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).
↳ 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 and update_mask is 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.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

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.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getCluster

Required. The resource being updated

Returns
Type Description
Google\Cloud\AlloyDb\V1\Cluster|null

hasCluster

clearCluster

setCluster

Required. The resource being updated

Parameter
Name Description
var Google\Cloud\AlloyDb\V1\Cluster
Returns
Type Description
$this

getRequestId

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 and update_mask is 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 and update_mask is ignored.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
cluster Google\Cloud\AlloyDb\V1\Cluster

Required. The resource being updated
updateMask Google\Protobuf\FieldMask

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.
Returns
Type Description
Google\Cloud\AlloyDb\V1\UpdateClusterRequest