backup_vaults

Creates, updates, deletes, gets or lists a backup_vaults resource.

Overview

Name	`backup_vaults`
Type	Resource
Id	`google.netapp.backup_vaults`

Fields

The following fields are returned by SELECT queries:

get
list

Successful response

Name	Datatype	Description
`name`	`string`	Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.
`backupRegion`	`string`	Optional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}`
`backupRetentionPolicy`	`object`	Optional. Backup retention policy defining the retenton of backups. (id: BackupRetentionPolicy)
`backupVaultType`	`string`	Optional. Type of backup vault to be created. Default is IN_REGION.
`createTime`	`string (google-datetime)`	Output only. Create time of the backup vault.
`description`	`string`	Description of the backup vault.
`destinationBackupVault`	`string`	Output only. Name of the Backup vault created in backup region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`
`labels`	`object`	Resource labels to represent user provided metadata.
`sourceBackupVault`	`string`	Output only. Name of the Backup vault created in source region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`
`sourceRegion`	`string`	Output only. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}`
`state`	`string`	Output only. The backup vault state.

Successful response

Name	Datatype	Description
`name`	`string`	Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.
`backupRegion`	`string`	Optional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}`
`backupRetentionPolicy`	`object`	Optional. Backup retention policy defining the retenton of backups. (id: BackupRetentionPolicy)
`backupVaultType`	`string`	Optional. Type of backup vault to be created. Default is IN_REGION.
`createTime`	`string (google-datetime)`	Output only. Create time of the backup vault.
`description`	`string`	Description of the backup vault.
`destinationBackupVault`	`string`	Output only. Name of the Backup vault created in backup region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`
`labels`	`object`	Resource labels to represent user provided metadata.
`sourceBackupVault`	`string`	Output only. Name of the Backup vault created in source region. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`
`sourceRegion`	`string`	Output only. Region in which the backup vault is created. Format: `projects/{project_id}/locations/{location}`
`state`	`string`	Output only. The backup vault state.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`projectsId`, `locationsId`, `backupVaultsId`		Returns the description of the specified backup vault
`list`	`select`	`projectsId`, `locationsId`	`pageSize`, `pageToken`, `orderBy`, `filter`	Returns list of all available backup vaults.
`create`	`insert`	`projectsId`, `locationsId`	`backupVaultId`	Creates new backup vault
`patch`	`update`	`projectsId`, `locationsId`, `backupVaultsId`	`updateMask`	Updates the settings of a specific backup vault.
`delete`	`delete`	`projectsId`, `locationsId`, `backupVaultsId`		Warning! This operation will permanently delete the backup vault.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`backupVaultsId`	`string`
`locationsId`	`string`
`projectsId`	`string`
`backupVaultId`	`string`
`filter`	`string`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`updateMask`	`string (google-fieldmask)`

`SELECT` examples

get
list

Returns the description of the specified backup vault

SELECT
name,
backupRegion,
backupRetentionPolicy,
backupVaultType,
createTime,
description,
destinationBackupVault,
labels,
sourceBackupVault,
sourceRegion,
state
FROM google.netapp.backup_vaults
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND backupVaultsId = '{{ backupVaultsId }}' -- required;

Returns list of all available backup vaults.

SELECT
name,
backupRegion,
backupRetentionPolicy,
backupVaultType,
createTime,
description,
destinationBackupVault,
labels,
sourceBackupVault,
sourceRegion,
state
FROM google.netapp.backup_vaults
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}';

`INSERT` examples

create
Manifest

Creates new backup vault

INSERT INTO google.netapp.backup_vaults (
data__name,
data__description,
data__labels,
data__backupVaultType,
data__backupRegion,
data__backupRetentionPolicy,
projectsId,
locationsId,
backupVaultId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ labels }}',
'{{ backupVaultType }}',
'{{ backupRegion }}',
'{{ backupRetentionPolicy }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ backupVaultId }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: backup_vaults
  props:
    - name: projectsId
      value: string
      description: Required parameter for the backup_vaults resource.
    - name: locationsId
      value: string
      description: Required parameter for the backup_vaults resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name of the backup vault. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}`.
        
    - name: description
      value: string
      description: >
        Description of the backup vault.
        
    - name: labels
      value: object
      description: >
        Resource labels to represent user provided metadata.
        
    - name: backupVaultType
      value: string
      description: >
        Optional. Type of backup vault to be created. Default is IN_REGION.
        
      valid_values: ['BACKUP_VAULT_TYPE_UNSPECIFIED', 'IN_REGION', 'CROSS_REGION']
    - name: backupRegion
      value: string
      description: >
        Optional. Region where the backups are stored. Format: `projects/{project_id}/locations/{location}`
        
    - name: backupRetentionPolicy
      value: object
      description: >
        Optional. Backup retention policy defining the retenton of backups.
        
    - name: backupVaultId
      value: string

`UPDATE` examples

patch

Updates the settings of a specific backup vault.

UPDATE google.netapp.backup_vaults
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__labels = '{{ labels }}',
data__backupVaultType = '{{ backupVaultType }}',
data__backupRegion = '{{ backupRegion }}',
data__backupRetentionPolicy = '{{ backupRetentionPolicy }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND backupVaultsId = '{{ backupVaultsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

`DELETE` examples

delete

Warning! This operation will permanently delete the backup vault.

DELETE FROM google.netapp.backup_vaults
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND backupVaultsId = '{{ backupVaultsId }}' --required;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​