Reference documentation and code samples for the AlloyDB V1ALPHA API class Google::Cloud::AlloyDB::V1alpha::UpdateBackupRequest.
Message for updating a Backup
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#allow_missing
defallow_missing()->::Boolean
Returns
(::Boolean) — Optional. If set to true, update succeeds even if instance is not found. In
that case, a new backup is created and update_mask is ignored.
#allow_missing=
defallow_missing=(value)->::Boolean
Parameter
value (::Boolean) — Optional. If set to true, update succeeds even if instance is not found. In
that case, a new backup 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 backup is created and update_mask is ignored.
(::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).
#request_id=
defrequest_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 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).
#update_mask
defupdate_mask()->::Google::Protobuf::FieldMask
Returns
(::Google::Protobuf::FieldMask) — Optional. Field mask is used to specify the fields to be overwritten in the
Backup 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.
value (::Google::Protobuf::FieldMask) — Optional. Field mask is used to specify the fields to be overwritten in the
Backup 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
Backup 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
defvalidate_only()->::Boolean
Returns
(::Boolean) — Optional. If set, the backend validates the request, but doesn't actually
execute it.
#validate_only=
defvalidate_only=(value)->::Boolean
Parameter
value (::Boolean) — Optional. If set, the backend validates the request, but doesn't actually
execute it.
Returns
(::Boolean) — Optional. If set, the backend validates the request, but doesn't actually
execute it.
[[["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,["# AlloyDB V1ALPHA API - Class Google::Cloud::AlloyDB::V1alpha::UpdateBackupRequest (v0.14.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.14.1 (latest)](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/latest/Google-Cloud-AlloyDB-V1alpha-UpdateBackupRequest)\n- [0.14.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.14.0/Google-Cloud-AlloyDB-V1alpha-UpdateBackupRequest)\n- [0.13.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.13.0/Google-Cloud-AlloyDB-V1alpha-UpdateBackupRequest)\n- [0.12.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.12.0/Google-Cloud-AlloyDB-V1alpha-UpdateBackupRequest)\n- [0.11.1](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.11.1/Google-Cloud-AlloyDB-V1alpha-UpdateBackupRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.10.0/Google-Cloud-AlloyDB-V1alpha-UpdateBackupRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.9.0/Google-Cloud-AlloyDB-V1alpha-UpdateBackupRequest)\n- [0.8.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.8.0/Google-Cloud-AlloyDB-V1alpha-UpdateBackupRequest)\n- [0.7.2](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.7.2/Google-Cloud-AlloyDB-V1alpha-UpdateBackupRequest)\n- [0.6.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.6.0/Google-Cloud-AlloyDB-V1alpha-UpdateBackupRequest)\n- [0.5.2](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.5.2/Google-Cloud-AlloyDB-V1alpha-UpdateBackupRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.4.0/Google-Cloud-AlloyDB-V1alpha-UpdateBackupRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.3.0/Google-Cloud-AlloyDB-V1alpha-UpdateBackupRequest)\n- [0.2.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.2.0/Google-Cloud-AlloyDB-V1alpha-UpdateBackupRequest)\n- [0.1.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.1.0/Google-Cloud-AlloyDB-V1alpha-UpdateBackupRequest) \nReference documentation and code samples for the AlloyDB V1ALPHA API class Google::Cloud::AlloyDB::V1alpha::UpdateBackupRequest.\n\nMessage for updating a Backup \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #allow_missing\n\n def allow_missing() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Optional. If set to true, update succeeds even if instance is not found. In that case, a new backup is created and `update_mask` is ignored.\n\n### #allow_missing=\n\n def allow_missing=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Optional. If set to true, update succeeds even if instance is not found. In that case, a new backup is created and `update_mask` is ignored. \n**Returns**\n\n- (::Boolean) --- Optional. If set to true, update succeeds even if instance is not found. In that case, a new backup is created and `update_mask` is ignored.\n\n### #backup\n\n def backup() -\u003e ::Google::Cloud::AlloyDB::V1alpha::Backup\n\n**Returns**\n\n- ([::Google::Cloud::AlloyDB::V1alpha::Backup](./Google-Cloud-AlloyDB-V1alpha-Backup)) --- Required. The resource being updated\n\n### #backup=\n\n def backup=(value) -\u003e ::Google::Cloud::AlloyDB::V1alpha::Backup\n\n**Parameter**\n\n- **value** ([::Google::Cloud::AlloyDB::V1alpha::Backup](./Google-Cloud-AlloyDB-V1alpha-Backup)) --- Required. The resource being updated \n**Returns**\n\n- ([::Google::Cloud::AlloyDB::V1alpha::Backup](./Google-Cloud-AlloyDB-V1alpha-Backup)) --- Required. The resource being updated\n\n### #request_id\n\n def request_id() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n For example, consider a situation where you make an initial request and\n the request times out. If you make the request again with the same request\n ID, the server can check if the original operation with the same request ID\n was received, and if so, ignores the second request. This prevents\n clients from accidentally creating duplicate commitments.\n\n The request ID must be a valid UUID with the exception that zero UUID is\n not supported (00000000-0000-0000-0000-000000000000).\n\n### #request_id=\n\n def request_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request.\n\n\n For example, consider a situation where you make an initial request and\n the request times out. If you make the request again with the same request\n ID, the server can check if the original operation with the same request ID\n was received, and if so, ignores the second request. This prevents\n clients from accidentally creating duplicate commitments.\n\n The request ID must be a valid UUID with the exception that zero UUID is\nnot supported (00000000-0000-0000-0000-000000000000). \n**Returns**\n\n- (::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.\n\n For example, consider a situation where you make an initial request and\n the request times out. If you make the request again with the same request\n ID, the server can check if the original operation with the same request ID\n was received, and if so, ignores the second request. This prevents\n clients from accidentally creating duplicate commitments.\n\n The request ID must be a valid UUID with the exception that zero UUID is\n not supported (00000000-0000-0000-0000-000000000000).\n\n### #update_mask\n\n def update_mask() -\u003e ::Google::Protobuf::FieldMask\n\n**Returns**\n\n- ([::Google::Protobuf::FieldMask](./Google-Protobuf-FieldMask)) --- Optional. Field mask is used to specify the fields to be overwritten in the Backup 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.\n\n### #update_mask=\n\n def update_mask=(value) -\u003e ::Google::Protobuf::FieldMask\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::FieldMask](./Google-Protobuf-FieldMask)) --- Optional. Field mask is used to specify the fields to be overwritten in the Backup 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. \n**Returns**\n\n- ([::Google::Protobuf::FieldMask](./Google-Protobuf-FieldMask)) --- Optional. Field mask is used to specify the fields to be overwritten in the Backup 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.\n\n### #validate_only\n\n def validate_only() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Optional. If set, the backend validates the request, but doesn't actually execute it.\n\n### #validate_only=\n\n def validate_only=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Optional. If set, the backend validates the request, but doesn't actually execute it. \n**Returns**\n\n- (::Boolean) --- Optional. If set, the backend validates the request, but doesn't actually execute it."]]
