Google Cloud Gke Backup V1 Client - Class BackupPlan (1.0.2)

Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class BackupPlan.

Defines the configuration and scheduling for a "line" of Backups.

Generated from protobuf message google.cloud.gkebackup.v1.BackupPlan

Namespace

Google \ Cloud \ GkeBackup \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Output only. The full name of the BackupPlan resource. Format: `projects//locations//backupPlans/*`
`↳ uid`	`string` Output only. Server generated global unique identifier of UUID format.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. The timestamp when this BackupPlan resource was created.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The timestamp when this BackupPlan resource was last updated.
`↳ description`	`string` Optional. User specified descriptive string for this BackupPlan.
`↳ cluster`	`string` Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - `projects//locations//clusters/` - `projects//zones//clusters/`
`↳ retention_policy`	`BackupPlan\RetentionPolicy` Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Optional. A set of custom labels supplied by user.
`↳ backup_schedule`	`BackupPlan\Schedule` Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
`↳ etag`	`string` Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackupPlan`, and systems are expected to put that etag in the request to `UpdateBackupPlan` or `DeleteBackupPlan` to ensure that their change will be applied to the same version of the resource.
`↳ deactivated`	`bool` Optional. This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False
`↳ backup_config`	`BackupPlan\BackupConfig` Optional. Defines the configuration of Backups created via this BackupPlan.
`↳ 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. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update
`↳ state_reason`	`string` Output only. Human-readable description of why BackupPlan is in the current `state`
`↳ 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.
`↳ rpo_risk_reason`	`string` Output only. Human-readable description of why the BackupPlan is in the current rpo_risk_level and action items if any.

getName

Output only. The full name of the BackupPlan resource.

Format: projects/*/locations/*/backupPlans/*

Returns
Type	Description
`string`

setName

Output only. The full name of the BackupPlan resource.

Format: projects/*/locations/*/backupPlans/*

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUid

Output only. Server generated global unique identifier of UUID format.

Returns
Type	Description
`string`

setUid

Output only. Server generated global unique identifier of UUID format.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. The timestamp when this BackupPlan resource was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp when this BackupPlan resource was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. The timestamp when this BackupPlan resource was last updated.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The timestamp when this BackupPlan resource was last updated.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getDescription

Optional. User specified descriptive string for this BackupPlan.

Returns
Type	Description
`string`

setDescription

Optional. User specified descriptive string for this BackupPlan.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCluster

Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats:

projects/*/locations/*/clusters/*
projects/*/zones/*/clusters/*

Returns
Type	Description
`string`

setCluster

Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats:

projects/*/locations/*/clusters/*
projects/*/zones/*/clusters/*

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRetentionPolicy

Optional. RetentionPolicy governs lifecycle of Backups created under this plan.

Returns
Type	Description
`BackupPlan\RetentionPolicy\|null`

hasRetentionPolicy

clearRetentionPolicy

setRetentionPolicy

Optional. RetentionPolicy governs lifecycle of Backups created under this plan.

Parameter
Name	Description
`var`	`BackupPlan\RetentionPolicy`

Returns
Type	Description
`$this`

getLabels

Optional. A set of custom labels supplied by user.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Optional. A set of custom labels supplied by user.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getBackupSchedule

Optional. Defines a schedule for automatic Backup creation via this BackupPlan.

Returns
Type	Description
`BackupPlan\Schedule\|null`

hasBackupSchedule

clearBackupSchedule

setBackupSchedule

Optional. Defines a schedule for automatic Backup creation via this BackupPlan.

Parameter
Name	Description
`var`	`BackupPlan\Schedule`

Returns
Type	Description
`$this`

getEtag

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlan, and systems are expected to put that etag in the request to UpdateBackupPlan or DeleteBackupPlan to ensure that their change will be applied to the same version of the resource.

Returns
Type	Description
`string`

setEtag

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDeactivated

Optional. This flag indicates whether this BackupPlan has been deactivated.

Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False

Returns
Type	Description
`bool`

setDeactivated

Optional. This flag indicates whether this BackupPlan has been deactivated.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getBackupConfig

Optional. Defines the configuration of Backups created via this BackupPlan.

Returns
Type	Description
`BackupPlan\BackupConfig\|null`

hasBackupConfig

clearBackupConfig

setBackupConfig

Optional. Defines the configuration of Backups created via this BackupPlan.

Parameter
Name	Description
`var`	`BackupPlan\BackupConfig`

Returns
Type	Description
`$this`

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. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update

Returns
Type	Description
`int`

setState

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getStateReason

Output only. Human-readable description of why BackupPlan is in the current state

Returns
Type	Description
`string`

setStateReason

Output only. Human-readable description of why BackupPlan is in the current state

Parameter
Name	Description
`var`	`string`

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`

getRpoRiskReason

Output only. Human-readable description of why the BackupPlan is in the current rpo_risk_level and action items if any.

Returns
Type	Description
`string`

setRpoRiskReason

Output only. Human-readable description of why the BackupPlan is in the current rpo_risk_level and action items if any.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`