Google Cloud Gke Backup V1 Client - Class ClusterResourceRestoreScope (0.7.2)

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

Defines the scope of cluster-scoped resources to restore.

Some group kinds are not reasonable choices for a restore, and will cause an error if selected here. Any scope selection that would restore "all valid" resources automatically excludes these group kinds.

  • gkebackup.gke.io/BackupJob
  • gkebackup.gke.io/RestoreJob
  • metrics.k8s.io/NodeMetrics
  • migration.k8s.io/StorageState
  • migration.k8s.io/StorageVersionMigration
  • Node
  • snapshot.storage.k8s.io/VolumeSnapshotContent
  • storage.k8s.io/CSINode Some group kinds are driven by restore configuration elsewhere, and will cause an error if selected here.
  • Namespace
  • PersistentVolume

Generated from protobuf message google.cloud.gkebackup.v1.RestoreConfig.ClusterResourceRestoreScope

Namespace

Google \ Cloud \ GkeBackup \ V1 \ RestoreConfig

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ selected_group_kinds array<Google\Cloud\GkeBackup\V1\RestoreConfig\GroupKind>

Optional. A list of cluster-scoped resource group kinds to restore from the backup. If specified, only the selected resources will be restored. Mutually exclusive to any other field in the message.

↳ excluded_group_kinds array<Google\Cloud\GkeBackup\V1\RestoreConfig\GroupKind>

Optional. A list of cluster-scoped resource group kinds to NOT restore from the backup. If specified, all valid cluster-scoped resources will be restored except for those specified in the list. Mutually exclusive to any other field in the message.

↳ all_group_kinds bool

Optional. If True, all valid cluster-scoped resources will be restored. Mutually exclusive to any other field in the message.

↳ no_group_kinds bool

Optional. If True, no cluster-scoped resources will be restored. This has the same restore scope as if the message is not defined. Mutually exclusive to any other field in the message.

getSelectedGroupKinds

Optional. A list of cluster-scoped resource group kinds to restore from the backup. If specified, only the selected resources will be restored.

Mutually exclusive to any other field in the message.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSelectedGroupKinds

Optional. A list of cluster-scoped resource group kinds to restore from the backup. If specified, only the selected resources will be restored.

Mutually exclusive to any other field in the message.

Parameter
Name Description
var array<Google\Cloud\GkeBackup\V1\RestoreConfig\GroupKind>
Returns
Type Description
$this

getExcludedGroupKinds

Optional. A list of cluster-scoped resource group kinds to NOT restore from the backup. If specified, all valid cluster-scoped resources will be restored except for those specified in the list.

Mutually exclusive to any other field in the message.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setExcludedGroupKinds

Optional. A list of cluster-scoped resource group kinds to NOT restore from the backup. If specified, all valid cluster-scoped resources will be restored except for those specified in the list.

Mutually exclusive to any other field in the message.

Parameter
Name Description
var array<Google\Cloud\GkeBackup\V1\RestoreConfig\GroupKind>
Returns
Type Description
$this

getAllGroupKinds

Optional. If True, all valid cluster-scoped resources will be restored.

Mutually exclusive to any other field in the message.

Returns
Type Description
bool

setAllGroupKinds

Optional. If True, all valid cluster-scoped resources will be restored.

Mutually exclusive to any other field in the message.

Parameter
Name Description
var bool
Returns
Type Description
$this

getNoGroupKinds

Optional. If True, no cluster-scoped resources will be restored.

This has the same restore scope as if the message is not defined. Mutually exclusive to any other field in the message.

Returns
Type Description
bool

setNoGroupKinds

Optional. If True, no cluster-scoped resources will be restored.

This has the same restore scope as if the message is not defined. Mutually exclusive to any other field in the message.

Parameter
Name Description
var bool
Returns
Type Description
$this