Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class BackupConfig.
BackupConfig defines the configuration of Backups created via this BackupPlan.
Generated from protobuf message google.cloud.gkebackup.v1.BackupPlan.BackupConfig
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ all_namespaces |
bool
If True, include all namespaced resources |
↳ selected_namespaces |
Google\Cloud\GkeBackup\V1\Namespaces
If set, include just the resources in the listed namespaces. |
↳ selected_applications |
Google\Cloud\GkeBackup\V1\NamespacedNames
If set, include just the resources referenced by the listed ProtectedApplications. |
↳ include_volume_data |
bool
This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup. Default: False |
↳ include_secrets |
bool
This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups. Default: False |
↳ encryption_key |
Google\Cloud\GkeBackup\V1\EncryptionKey
This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan. Default (empty): Config backup artifacts will not be encrypted. |
getAllNamespaces
If True, include all namespaced resources
| Returns | |
|---|---|
| Type | Description |
bool | |
hasAllNamespaces
setAllNamespaces
If True, include all namespaced resources
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSelectedNamespaces
If set, include just the resources in the listed namespaces.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeBackup\V1\Namespaces|null | |
hasSelectedNamespaces
setSelectedNamespaces
If set, include just the resources in the listed namespaces.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeBackup\V1\Namespaces
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSelectedApplications
If set, include just the resources referenced by the listed ProtectedApplications.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeBackup\V1\NamespacedNames|null | |
hasSelectedApplications
setSelectedApplications
If set, include just the resources referenced by the listed ProtectedApplications.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeBackup\V1\NamespacedNames
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIncludeVolumeData
This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup.
Default: False
| Returns | |
|---|---|
| Type | Description |
bool | |
setIncludeVolumeData
This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup.
Default: False
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIncludeSecrets
This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups.
Default: False
| Returns | |
|---|---|
| Type | Description |
bool | |
setIncludeSecrets
This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups.
Default: False
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEncryptionKey
This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan.
Default (empty): Config backup artifacts will not be encrypted.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeBackup\V1\EncryptionKey|null | |
hasEncryptionKey
clearEncryptionKey
setEncryptionKey
This defines a customer managed encryption key that will be used to encrypt the "config" portion (the Kubernetes resources) of Backups created via this plan.
Default (empty): Config backup artifacts will not be encrypted.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeBackup\V1\EncryptionKey
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBackupScope
| Returns | |
|---|---|
| Type | Description |
string | |