Google Cloud Net App V1 Client - Class BackupVault (1.7.0)

Reference documentation and code samples for the Google Cloud Net App V1 Client class BackupVault.

A NetApp BackupVault.

Generated from protobuf message google.cloud.netapp.v1.BackupVault

Namespace

Google \ Cloud \ NetApp \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The resource name of the backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}.

↳ state int

Output only. The backup vault state.

↳ create_time Google\Protobuf\Timestamp

Output only. Create time of the backup vault.

↳ description string

Description of the backup vault.

↳ labels array|Google\Protobuf\Internal\MapField

Resource labels to represent user provided metadata.

↳ backup_vault_type int

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

↳ source_region string

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

↳ backup_region string

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

↳ source_backup_vault string

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

↳ destination_backup_vault string

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

↳ backup_retention_policy BackupVault\BackupRetentionPolicy

Optional. Backup retention policy defining the retenton of backups.

getName

Identifier. The resource name of the backup vault.

Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}.

Returns
Type Description
string

setName

Identifier. The resource name of the backup vault.

Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. The backup vault state.

Returns
Type Description
int Enum of type State.

setState

Output only. The backup vault state.

Parameter
Name Description
var int

Enum of type State.

Returns
Type Description
$this

getCreateTime

Output only. Create time of the backup vault.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Create time of the backup vault.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getDescription

Description of the backup vault.

Returns
Type Description
string

setDescription

Description of the backup vault.

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

Resource labels to represent user provided metadata.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Resource labels to represent user provided metadata.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getBackupVaultType

Optional. Type of backup vault to be created.

Default is IN_REGION.

Returns
Type Description
int Enum of type BackupVaultType.

setBackupVaultType

Optional. Type of backup vault to be created.

Default is IN_REGION.

Parameter
Name Description
var int

Enum of type BackupVaultType.

Returns
Type Description
$this

getSourceRegion

Output only. Region in which the backup vault is created.

Format: projects/{project_id}/locations/{location}

Returns
Type Description
string

setSourceRegion

Output only. Region in which the backup vault is created.

Format: projects/{project_id}/locations/{location}

Parameter
Name Description
var string
Returns
Type Description
$this

getBackupRegion

Optional. Region where the backups are stored.

Format: projects/{project_id}/locations/{location}

Returns
Type Description
string

setBackupRegion

Optional. Region where the backups are stored.

Format: projects/{project_id}/locations/{location}

Parameter
Name Description
var string
Returns
Type Description
$this

getSourceBackupVault

Output only. Name of the Backup vault created in source region.

Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}

Returns
Type Description
string

setSourceBackupVault

Output only. Name of the Backup vault created in source region.

Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getDestinationBackupVault

Output only. Name of the Backup vault created in backup region.

Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}

Returns
Type Description
string

setDestinationBackupVault

Output only. Name of the Backup vault created in backup region.

Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getBackupRetentionPolicy

Optional. Backup retention policy defining the retenton of backups.

Returns
Type Description
BackupVault\BackupRetentionPolicy|null

hasBackupRetentionPolicy

clearBackupRetentionPolicy

setBackupRetentionPolicy

Optional. Backup retention policy defining the retenton of backups.

Parameter
Name Description
var BackupVault\BackupRetentionPolicy
Returns
Type Description
$this