Google Cloud Net App V1 Client - Class BackupPolicy (1.0.0)

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

Backup Policy.

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

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 policy. Format: projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}.

↳ daily_backup_limit int

Number of daily backups to keep. Note that the minimum daily backup limit is 2.

↳ weekly_backup_limit int

Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.

↳ monthly_backup_limit int

Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.

↳ description string

Description of the backup policy.

↳ enabled bool

If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.

↳ assigned_volume_count int

Output only. The total number of volumes assigned by this backup policy.

↳ create_time Google\Protobuf\Timestamp

Output only. The time when the backup policy was created.

↳ labels array|Google\Protobuf\Internal\MapField

Resource labels to represent user provided metadata.

↳ state int

Output only. The backup policy state.

getName

Identifier. The resource name of the backup policy.

Format: projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}.

Returns
Type Description
string

setName

Identifier. The resource name of the backup policy.

Format: projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}.

Parameter
Name Description
var string
Returns
Type Description
$this

getDailyBackupLimit

Number of daily backups to keep. Note that the minimum daily backup limit is 2.

Returns
Type Description
int

hasDailyBackupLimit

clearDailyBackupLimit

setDailyBackupLimit

Number of daily backups to keep. Note that the minimum daily backup limit is 2.

Parameter
Name Description
var int
Returns
Type Description
$this

getWeeklyBackupLimit

Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.

Returns
Type Description
int

hasWeeklyBackupLimit

clearWeeklyBackupLimit

setWeeklyBackupLimit

Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.

Parameter
Name Description
var int
Returns
Type Description
$this

getMonthlyBackupLimit

Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.

Returns
Type Description
int

hasMonthlyBackupLimit

clearMonthlyBackupLimit

setMonthlyBackupLimit

Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.

Parameter
Name Description
var int
Returns
Type Description
$this

getDescription

Description of the backup policy.

Returns
Type Description
string

hasDescription

clearDescription

setDescription

Description of the backup policy.

Parameter
Name Description
var string
Returns
Type Description
$this

getEnabled

If enabled, make backups automatically according to the schedules.

This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.

Returns
Type Description
bool

hasEnabled

clearEnabled

setEnabled

If enabled, make backups automatically according to the schedules.

This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.

Parameter
Name Description
var bool
Returns
Type Description
$this

getAssignedVolumeCount

Output only. The total number of volumes assigned by this backup policy.

Returns
Type Description
int

hasAssignedVolumeCount

clearAssignedVolumeCount

setAssignedVolumeCount

Output only. The total number of volumes assigned by this backup policy.

Parameter
Name Description
var int
Returns
Type Description
$this

getCreateTime

Output only. The time when the backup policy was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the backup policy was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
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

getState

Output only. The backup policy state.

Returns
Type Description
int

setState

Output only. The backup policy state.

Parameter
Name Description
var int
Returns
Type Description
$this