Console
    Start free

    REST Resource: projects.locations.backupVaults

    Resource: BackupVault

    A NetApp BackupVault.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "state" 
 : 
 enum (  State 
 
) 
 , 
 "createTime" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "labels" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "backupVaultType" 
 : 
 enum (  BackupVaultType 
 
) 
 , 
 "sourceRegion" 
 : 
 string 
 , 
 "backupRegion" 
 : 
 string 
 , 
 "sourceBackupVault" 
 : 
 string 
 , 
 "destinationBackupVault" 
 : 
 string 
 , 
 "backupRetentionPolicy" 
 : 
 { 
 object (  BackupRetentionPolicy 
 
) 
 } 
 , 
 "kmsConfig" 
 : 
 string 
 , 
 "encryptionState" 
 : 
 enum (  EncryptionState 
 
) 
 , 
 "backupsCryptoKeyVersion" 
 : 
 string 
 }
    Fields
    name

    string

    Identifier. The resource name of the backup vault. Format: projects/{projectId}/locations/{location}/backupVaults/{backupVaultId} .
    state

    enum ( State )

    Output only. The backup vault state.
    createTime

    string ( Timestamp format)

    Output only. Create time of the backup vault.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    description

    string

    Description of the backup vault.
    labels

    map (key: string, value: string)

    Resource labels to represent user provided metadata.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
    backupVaultType

    enum ( BackupVaultType )

    Optional. Type of backup vault to be created. Default is IN_REGION.
    sourceRegion

    string

    Output only. Region in which the backup vault is created. Format: projects/{projectId}/locations/{location}

    backupRegion

    string

    Optional. Region where the backups are stored. Format: projects/{projectId}/locations/{location}

    sourceBackupVault

    string

    Output only. Name of the Backup vault created in source region. Format: projects/{projectId}/locations/{location}/backupVaults/{backupVaultId}

    destinationBackupVault

    string

    Output only. Name of the Backup vault created in backup region. Format: projects/{projectId}/locations/{location}/backupVaults/{backupVaultId}

    backupRetentionPolicy

    object ( BackupRetentionPolicy )

    Optional. Backup retention policy defining the retention of backups.
    kmsConfig

    string

    Optional. Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: projects/{project}/locations/{location}/kmsConfigs/{kmsConfig}

    encryptionState

    enum ( EncryptionState )

    Output only. Field indicating encryption state of CMEK backups.
    backupsCryptoKeyVersion

    string

    Output only. The crypto key version used to encrypt the backup vault. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}

    State

    The Backup Vault States

    Enums
    STATE_UNSPECIFIED State not set.
    CREATING BackupVault is being created.
    READY BackupVault is available for use.
    DELETING BackupVault is being deleted.
    ERROR BackupVault is not valid and cannot be used.
    UPDATING BackupVault is being updated.

    BackupVaultType

    Backup Vault Type.

    Enums
    BACKUP_VAULT_TYPE_UNSPECIFIED BackupVault type not set.
    IN_REGION BackupVault type is IN_REGION.
    CROSS_REGION BackupVault type is CROSS_REGION.

    BackupRetentionPolicy

    Retention policy for backups in the backup vault

    JSON representation 
     { 
 "backupMinimumEnforcedRetentionDays" 
 : 
 integer 
 , 
 "dailyBackupImmutable" 
 : 
 boolean 
 , 
 "weeklyBackupImmutable" 
 : 
 boolean 
 , 
 "monthlyBackupImmutable" 
 : 
 boolean 
 , 
 "manualBackupImmutable" 
 : 
 boolean 
 }
    Fields
    backupMinimumEnforcedRetentionDays

    integer

    Required. Minimum retention duration in days for backups in the backup vault.
    dailyBackupImmutable

    boolean

    Optional. Indicates if the daily backups are immutable. At least one of dailyBackupImmutable, weeklyBackupImmutable, monthlyBackupImmutable and manualBackupImmutable must be true.
    weeklyBackupImmutable

    boolean

    Optional. Indicates if the weekly backups are immutable. At least one of dailyBackupImmutable, weeklyBackupImmutable, monthlyBackupImmutable and manualBackupImmutable must be true.
    monthlyBackupImmutable

    boolean

    Optional. Indicates if the monthly backups are immutable. At least one of dailyBackupImmutable, weeklyBackupImmutable, monthlyBackupImmutable and manualBackupImmutable must be true.
    manualBackupImmutable

    boolean

    Optional. Indicates if the manual backups are immutable. At least one of dailyBackupImmutable, weeklyBackupImmutable, monthlyBackupImmutable and manualBackupImmutable must be true.

    EncryptionState

    Encryption state of customer-managed encryption keys (CMEK) backups.

    Enums
    ENCRYPTION_STATE_UNSPECIFIED Encryption state not set.
    ENCRYPTION_STATE_PENDING Encryption state is pending.
    ENCRYPTION_STATE_COMPLETED Encryption is complete.
    ENCRYPTION_STATE_IN_PROGRESS Encryption is in progress.
    ENCRYPTION_STATE_FAILED Encryption has failed.

    Methods

    create

    		Creates new backup vault

    delete

    		Warning!

    get

    		Returns the description of the specified backup vault

    list

    		Returns list of all available backup vaults.

    patch

    		Updates the settings of a specific backup vault.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: