Google Cloud Backup Dr V1 Client - Class DeleteBackupVaultRequest (0.4.2)

Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class DeleteBackupVaultRequest.

Message for deleting a BackupVault.

Generated from protobuf message google.cloud.backupdr.v1.DeleteBackupVaultRequest

Namespace

Google \ Cloud \ BackupDR \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. Name of the resource.

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

↳ force bool

Optional. If set to true, any data source from this backup vault will also be deleted.

↳ etag 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.

↳ validate_only bool

Optional. Only validate the request, but do not perform mutations. The default is 'false'.

↳ allow_missing bool

Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken.

getName

Required. Name of the resource.

Returns
Type Description
string

setName

Required. Name of the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getRequestId

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
Type Description
string

setRequestId

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

Parameter
Name Description
var string
Returns
Type Description
$this

getForce

Optional. If set to true, any data source from this backup vault will also be deleted.

Returns
Type Description
bool

setForce

Optional. If set to true, any data source from this backup vault will also be deleted.

Parameter
Name Description
var bool
Returns
Type Description
$this

getEtag

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
Type Description
string

setEtag

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getValidateOnly

Optional. Only validate the request, but do not perform mutations.

The default is 'false'.

Returns
Type Description
bool

setValidateOnly

Optional. Only validate the request, but do not perform mutations.

The default is 'false'.

Parameter
Name Description
var bool
Returns
Type Description
$this

getAllowMissing

Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken.

Returns
Type Description
bool

setAllowMissing

Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. Name of the resource. Please see BackupDRClient::backupVaultName() for help formatting this field.

Returns
Type Description
DeleteBackupVaultRequest