Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class BackupPlanDetails.
Contains metadata about the backup plan/backup.
Generated from protobuf message google.cloud.gkebackup.v1.BackupPlanBinding.BackupPlanDetails
Namespace
Google \ Cloud \ GkeBackup \ V1 \ BackupPlanBindingMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ protected_pod_count |
int
Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan. |
↳ state |
int
Output only. State of the BackupPlan. |
↳ last_successful_backup_time |
Google\Protobuf\Timestamp
Output only. Completion time of the last successful Backup. This is sourced from a successful Backup's complete_time field. |
↳ next_scheduled_backup_time |
Google\Protobuf\Timestamp
Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule or rpo config. This is sourced from BackupPlan. |
↳ rpo_risk_level |
int
Output only. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk. |
↳ last_successful_backup |
string
Output only. The fully qualified name of the last successful Backup created under this BackupPlan. |
↳ backup_config_details |
BackupPlanDetails\BackupConfigDetails
Output only. Contains details about the BackupConfig of Backups created via this BackupPlan. |
↳ retention_policy_details |
BackupPlanDetails\RetentionPolicyDetails
Output only. Contains details about the RetentionPolicy of Backups created via this BackupPlan. |
getProtectedPodCount
Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
| Returns | |
|---|---|
| Type | Description |
int |
|
setProtectedPodCount
Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. State of the BackupPlan.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. State of the BackupPlan.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLastSuccessfulBackupTime
Output only. Completion time of the last successful Backup. This is sourced from a successful Backup's complete_time field.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasLastSuccessfulBackupTime
clearLastSuccessfulBackupTime
setLastSuccessfulBackupTime
Output only. Completion time of the last successful Backup. This is sourced from a successful Backup's complete_time field.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNextScheduledBackupTime
Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule or rpo config. This is sourced from BackupPlan.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasNextScheduledBackupTime
clearNextScheduledBackupTime
setNextScheduledBackupTime
Output only. Start time of next scheduled backup under this BackupPlan by either cron_schedule or rpo config. This is sourced from BackupPlan.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRpoRiskLevel
Output only. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk.
| Returns | |
|---|---|
| Type | Description |
int |
|
setRpoRiskLevel
Output only. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLastSuccessfulBackup
Output only. The fully qualified name of the last successful Backup created under this BackupPlan.
projects/*/locations/*/backupPlans/*/backups/*
| Returns | |
|---|---|
| Type | Description |
string |
|
setLastSuccessfulBackup
Output only. The fully qualified name of the last successful Backup created under this BackupPlan.
projects/*/locations/*/backupPlans/*/backups/*
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBackupConfigDetails
Output only. Contains details about the BackupConfig of Backups created via this BackupPlan.
| Returns | |
|---|---|
| Type | Description |
BackupPlanDetails\BackupConfigDetails|null |
|
hasBackupConfigDetails
clearBackupConfigDetails
setBackupConfigDetails
Output only. Contains details about the BackupConfig of Backups created via this BackupPlan.
| Parameter | |
|---|---|
| Name | Description |
var |
BackupPlanDetails\BackupConfigDetails
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRetentionPolicyDetails
Output only. Contains details about the RetentionPolicy of Backups created via this BackupPlan.
| Returns | |
|---|---|
| Type | Description |
BackupPlanDetails\RetentionPolicyDetails|null |
|
hasRetentionPolicyDetails
clearRetentionPolicyDetails
setRetentionPolicyDetails
Output only. Contains details about the RetentionPolicy of Backups created via this BackupPlan.
| Parameter | |
|---|---|
| Name | Description |
var |
BackupPlanDetails\RetentionPolicyDetails
|
| Returns | |
|---|---|
| Type | Description |
$this |
|