Class: Google::Cloud::AlloyDB::V1::UpdateClusterRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/alloydb/v1/service.rb

Overview

Message for updating a Cluster

Instance Attribute Summary collapse

Instance Attribute Details

#allow_missing ⇒ ::Boolean

Returns 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:

  • (::Boolean) —

    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.



184
185
186
187
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 184

class UpdateClusterRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#cluster ⇒ ::Google::Cloud::AlloyDB::V1::Cluster

Returns Required. The resource being updated.

Returns:



184
185
186
187
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 184

class UpdateClusterRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#request_id ⇒ ::String

Returns 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:

  • (::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).



184
185
186
187
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 184

class UpdateClusterRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_mask ⇒ ::Google::Protobuf::FieldMask

Returns 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:

  • (::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.



184
185
186
187
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 184

class UpdateClusterRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#validate_only ⇒ ::Boolean

Returns 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:

  • (::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.



184
185
186
187
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 184

class UpdateClusterRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end