Backup for GKE V1 API - Class Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig (v1.5.0)

Reference documentation and code samples for the Backup for GKE V1 API class Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig.

BackupConfig defines the configuration of Backups created via this BackupPlan.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#all_namespaces

def all_namespaces() -> ::Boolean
Returns
  • (::Boolean) — If True, include all namespaced resources

    Note: The following fields are mutually exclusive: all_namespaces, selected_namespaces, selected_applications. If a field in that set is populated, all other fields in the set will automatically be cleared.

#all_namespaces=

def all_namespaces=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If True, include all namespaced resources

    Note: The following fields are mutually exclusive: all_namespaces, selected_namespaces, selected_applications. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Boolean) — If True, include all namespaced resources

    Note: The following fields are mutually exclusive: all_namespaces, selected_namespaces, selected_applications. If a field in that set is populated, all other fields in the set will automatically be cleared.

#encryption_key

def encryption_key() -> ::Google::Cloud::GkeBackup::V1::EncryptionKey
Returns
  • (::Google::Cloud::GkeBackup::V1::EncryptionKey) — Optional. 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.

#encryption_key=

def encryption_key=(value) -> ::Google::Cloud::GkeBackup::V1::EncryptionKey
Parameter
  • value (::Google::Cloud::GkeBackup::V1::EncryptionKey) — Optional. 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
  • (::Google::Cloud::GkeBackup::V1::EncryptionKey) — Optional. 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.

#include_secrets

def include_secrets() -> ::Boolean
Returns
  • (::Boolean) — Optional. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups.

    Default: False

#include_secrets=

def include_secrets=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups.

    Default: False

Returns
  • (::Boolean) — Optional. This flag specifies whether Kubernetes Secret resources should be included when they fall into the scope of Backups.

    Default: False

#include_volume_data

def include_volume_data() -> ::Boolean
Returns
  • (::Boolean) — Optional. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup.

    Default: False

#include_volume_data=

def include_volume_data=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup.

    Default: False

Returns
  • (::Boolean) — Optional. This flag specifies whether volume data should be backed up when PVCs are included in the scope of a Backup.

    Default: False

#permissive_mode

def permissive_mode() -> ::Boolean
Returns
  • (::Boolean) — Optional. If false, Backups will fail when Backup for GKE detects Kubernetes configuration that is non-standard or requires additional setup to restore.

    Default: False

#permissive_mode=

def permissive_mode=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If false, Backups will fail when Backup for GKE detects Kubernetes configuration that is non-standard or requires additional setup to restore.

    Default: False

Returns
  • (::Boolean) — Optional. If false, Backups will fail when Backup for GKE detects Kubernetes configuration that is non-standard or requires additional setup to restore.

    Default: False

#selected_applications

def selected_applications() -> ::Google::Cloud::GkeBackup::V1::NamespacedNames
Returns
  • (::Google::Cloud::GkeBackup::V1::NamespacedNames) — If set, include just the resources referenced by the listed ProtectedApplications.

    Note: The following fields are mutually exclusive: selected_applications, all_namespaces, selected_namespaces. If a field in that set is populated, all other fields in the set will automatically be cleared.

#selected_applications=

def selected_applications=(value) -> ::Google::Cloud::GkeBackup::V1::NamespacedNames
Parameter
  • value (::Google::Cloud::GkeBackup::V1::NamespacedNames) — If set, include just the resources referenced by the listed ProtectedApplications.

    Note: The following fields are mutually exclusive: selected_applications, all_namespaces, selected_namespaces. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::GkeBackup::V1::NamespacedNames) — If set, include just the resources referenced by the listed ProtectedApplications.

    Note: The following fields are mutually exclusive: selected_applications, all_namespaces, selected_namespaces. If a field in that set is populated, all other fields in the set will automatically be cleared.

#selected_namespaces

def selected_namespaces() -> ::Google::Cloud::GkeBackup::V1::Namespaces
Returns
  • (::Google::Cloud::GkeBackup::V1::Namespaces) — If set, include just the resources in the listed namespaces.

    Note: The following fields are mutually exclusive: selected_namespaces, all_namespaces, selected_applications. If a field in that set is populated, all other fields in the set will automatically be cleared.

#selected_namespaces=

def selected_namespaces=(value) -> ::Google::Cloud::GkeBackup::V1::Namespaces
Parameter
  • value (::Google::Cloud::GkeBackup::V1::Namespaces) — If set, include just the resources in the listed namespaces.

    Note: The following fields are mutually exclusive: selected_namespaces, all_namespaces, selected_applications. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::GkeBackup::V1::Namespaces) — If set, include just the resources in the listed namespaces.

    Note: The following fields are mutually exclusive: selected_namespaces, all_namespaces, selected_applications. If a field in that set is populated, all other fields in the set will automatically be cleared.