Reference documentation and code samples for the Backup and DR Service V1 API class Google::Cloud::BackupDR::V1::DeleteBackupVaultRequest.
Message for deleting a BackupVault.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#allow_missing
defallow_missing()->::Boolean
Returns
(::Boolean) — Optional. If true and the BackupVault is not found, the request will
succeed but no action will be taken.
#allow_missing=
defallow_missing=(value)->::Boolean
Parameter
value (::Boolean) — Optional. If true and the BackupVault is not found, the request will
succeed but no action will be taken.
Returns
(::Boolean) — Optional. If true and the BackupVault is not found, the request will
succeed but no action will be taken.
#etag
defetag()->::String
Returns
(::String) — The current etag of the backup vault.
If an etag is provided and does not match the current etag of the
connection, deletion will be blocked.
#etag=
defetag=(value)->::String
Parameter
value (::String) — The current etag of the backup vault.
If an etag is provided and does not match the current etag of the
connection, deletion will be blocked.
Returns
(::String) — The current etag of the backup vault.
If an etag is provided and does not match the current etag of the
connection, deletion will be blocked.
#force
defforce()->::Boolean
Returns
(::Boolean) — Optional. If set to true, any data source from this backup vault will also
be deleted.
#force=
defforce=(value)->::Boolean
Parameter
value (::Boolean) — Optional. If set to true, any data source from this backup vault will also
be deleted.
Returns
(::Boolean) — Optional. If set to true, any data source from this backup vault will also
be deleted.
#ignore_backup_plan_references
defignore_backup_plan_references()->::Boolean
Returns
(::Boolean) — Optional. If set to true, backupvault deletion will proceed even if there
are backup plans referencing the backupvault. The default is 'false'.
value (::Boolean) — Optional. If set to true, backupvault deletion will proceed even if there
are backup plans referencing the backupvault. The default is 'false'.
Returns
(::Boolean) — Optional. If set to true, backupvault deletion will proceed even if there
are backup plans referencing the backupvault. The default is 'false'.
#name
defname()->::String
Returns
(::String) — Required. Name of the resource.
#name=
defname=(value)->::String
Parameter
value (::String) — Required. Name of the resource.
Returns
(::String) — Required. Name of the resource.
#request_id
defrequest_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 after 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=
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 will know to
ignore the request if it has already been completed. The server will
guarantee that for at least 60 minutes after 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 after 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).
#validate_only
defvalidate_only()->::Boolean
Returns
(::Boolean) — Optional. Only validate the request, but do not perform mutations.
The default is 'false'.
#validate_only=
defvalidate_only=(value)->::Boolean
Parameter
value (::Boolean) — Optional. Only validate the request, but do not perform mutations.
The default is 'false'.
Returns
(::Boolean) — Optional. Only validate the request, but do not perform mutations.
The default is 'false'.
[[["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,["# Backup and DR Service V1 API - Class Google::Cloud::BackupDR::V1::DeleteBackupVaultRequest (v1.2.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.0 (latest)](/ruby/docs/reference/google-cloud-backupdr-v1/latest/Google-Cloud-BackupDR-V1-DeleteBackupVaultRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-backupdr-v1/1.1.0/Google-Cloud-BackupDR-V1-DeleteBackupVaultRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-backupdr-v1/1.0.1/Google-Cloud-BackupDR-V1-DeleteBackupVaultRequest)\n- [0.5.0](/ruby/docs/reference/google-cloud-backupdr-v1/0.5.0/Google-Cloud-BackupDR-V1-DeleteBackupVaultRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-backupdr-v1/0.4.0/Google-Cloud-BackupDR-V1-DeleteBackupVaultRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-backupdr-v1/0.3.0/Google-Cloud-BackupDR-V1-DeleteBackupVaultRequest)\n- [0.2.1](/ruby/docs/reference/google-cloud-backupdr-v1/0.2.1/Google-Cloud-BackupDR-V1-DeleteBackupVaultRequest)\n- [0.1.0](/ruby/docs/reference/google-cloud-backupdr-v1/0.1.0/Google-Cloud-BackupDR-V1-DeleteBackupVaultRequest) \nReference documentation and code samples for the Backup and DR Service V1 API class Google::Cloud::BackupDR::V1::DeleteBackupVaultRequest.\n\nMessage for deleting a BackupVault. \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 true and the BackupVault is not found, the request will succeed but no action will be taken.\n\n### #allow_missing=\n\n def allow_missing=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken. \n**Returns**\n\n- (::Boolean) --- Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken.\n\n### #etag\n\n def etag() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The current etag of the backup vault. If an etag is provided and does not match the current etag of the connection, deletion will be blocked.\n\n### #etag=\n\n def etag=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The current etag of the backup vault. If an etag is provided and does not match the current etag of the connection, deletion will be blocked. \n**Returns**\n\n- (::String) --- The current etag of the backup vault. If an etag is provided and does not match the current etag of the connection, deletion will be blocked.\n\n### #force\n\n def force() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Optional. If set to true, any data source from this backup vault will also be deleted.\n\n### #force=\n\n def force=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Optional. If set to true, any data source from this backup vault will also be deleted. \n**Returns**\n\n- (::Boolean) --- Optional. If set to true, any data source from this backup vault will also be deleted.\n\n### #ignore_backup_plan_references\n\n def ignore_backup_plan_references() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Optional. If set to true, backupvault deletion will proceed even if there are backup plans referencing the backupvault. The default is 'false'.\n\n### #ignore_backup_plan_references=\n\n def ignore_backup_plan_references=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Optional. If set to true, backupvault deletion will proceed even if there are backup plans referencing the backupvault. The default is 'false'. \n**Returns**\n\n- (::Boolean) --- Optional. If set to true, backupvault deletion will proceed even if there are backup plans referencing the backupvault. The default is 'false'.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. Name of the resource.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. Name of the resource. \n**Returns**\n\n- (::String) --- Required. Name of the resource.\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 will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after 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 original operation with the same request ID\n was received, and if so, will ignore 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 will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after 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 original operation with the same request ID\n was received, and if so, will ignore 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 will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after 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 original operation with the same request ID\n was received, and if so, will ignore 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### #validate_only\n\n def validate_only() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Optional. Only validate the request, but do not perform mutations. The default is 'false'.\n\n### #validate_only=\n\n def validate_only=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Optional. Only validate the request, but do not perform mutations. The default is 'false'. \n**Returns**\n\n- (::Boolean) --- Optional. Only validate the request, but do not perform mutations. The default is 'false'."]]
