AlloyDB V1 API - Class Google::Cloud::AlloyDB::V1::UpdateInstanceRequest (v0.3.0)

Reference documentation and code samples for the AlloyDB V1 API class Google::Cloud::AlloyDB::V1::UpdateInstanceRequest.

Message for updating a Instance

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#allow_missing

def allow_missing() -> ::Boolean
Returns
  • (::Boolean) — Optional. If set to true, update succeeds even if instance is not found. In that case, a new instance is created and update_mask is ignored.

#allow_missing=

def allow_missing=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If set to true, update succeeds even if instance is not found. In that case, a new instance is created and update_mask is ignored.
Returns
  • (::Boolean) — Optional. If set to true, update succeeds even if instance is not found. In that case, a new instance is created and update_mask is ignored.

#instance

def instance() -> ::Google::Cloud::AlloyDB::V1::Instance
Returns

#instance=

def instance=(value) -> ::Google::Cloud::AlloyDB::V1::Instance
Parameter
Returns

#request_id

def request_id() -> ::String
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 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).

#request_id=

def request_id=(value) -> ::String
Parameter
  • value (::String) — 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).

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

#update_mask

def update_mask() -> ::Google::Protobuf::FieldMask
Returns
  • (::Google::Protobuf::FieldMask) — Optional. Field mask is used to specify the fields to be overwritten in the Instance 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.

#update_mask=

def update_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
  • value (::Google::Protobuf::FieldMask) — Optional. Field mask is used to specify the fields to be overwritten in the Instance 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 Instance 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.

#validate_only

def validate_only() -> ::Boolean
Returns
  • (::Boolean) — Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.

#validate_only=

def validate_only=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.
Returns
  • (::Boolean) — Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.