AlloyDB v1 API - Class UpdateClusterRequest (1.5.0)

public sealed class UpdateClusterRequest : IMessage<UpdateClusterRequest>, IEquatable<UpdateClusterRequest>, IDeepCloneable<UpdateClusterRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the AlloyDB v1 API class UpdateClusterRequest.

Message for updating a Cluster

Inheritance

object > UpdateClusterRequest

Implements

IMessage UpdateClusterRequest, IEquatable UpdateClusterRequest, IDeepCloneable UpdateClusterRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AlloyDb.V1

Assembly

Google.Cloud.AlloyDb.V1.dll

Constructors

UpdateClusterRequest()

public UpdateClusterRequest()

UpdateClusterRequest(UpdateClusterRequest)

public UpdateClusterRequest(UpdateClusterRequest other)

Parameter
Name	Description
`other`	`UpdateClusterRequest`

Properties

AllowMissing

public bool AllowMissing { get; set; }

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.

Property Value
Type	Description
`bool`

Cluster

public Cluster Cluster { get; set; }

Required. The resource being updated

Property Value
Type	Description
`Cluster`

RequestId

public string RequestId { get; set; }

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).

Property Value
Type	Description
`string`

UpdateMask

public FieldMask UpdateMask { get; set; }

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.

Property Value
Type	Description
`FieldMask`

ValidateOnly

public bool ValidateOnly { get; set; }

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

Property Value
Type	Description
`bool`