Google Cloud Gke Backup V1 Client - Class BackupConfig (0.3.1)

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

Namespace

Google \ Cloud \ GkeBackup \ V1 \ BackupPlan

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
bool

hasAllNamespaces

setAllNamespaces

If True, include all namespaced resources

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getSelectedNamespaces

If set, include just the resources in the listed namespaces.

Returns
TypeDescription
Google\Cloud\GkeBackup\V1\Namespaces|null

hasSelectedNamespaces

setSelectedNamespaces

If set, include just the resources in the listed namespaces.

Parameter
NameDescription
var Google\Cloud\GkeBackup\V1\Namespaces
Returns
TypeDescription
$this

getSelectedApplications

If set, include just the resources referenced by the listed ProtectedApplications.

Returns
TypeDescription
Google\Cloud\GkeBackup\V1\NamespacedNames|null

hasSelectedApplications

setSelectedApplications

If set, include just the resources referenced by the listed ProtectedApplications.

Parameter
NameDescription
var Google\Cloud\GkeBackup\V1\NamespacedNames
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var bool
Returns
TypeDescription
$this

getIncludeSecrets

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups.

Default: False

Returns
TypeDescription
bool

setIncludeSecrets

This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups.

Default: False

Parameter
NameDescription
var bool
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Cloud\GkeBackup\V1\EncryptionKey
Returns
TypeDescription
$this

getBackupScope

Returns
TypeDescription
string