Classes
Backup
Represents a request to perform a single point-in-time capture of some portion of the state of a GKE cluster, the record of the backup operation itself, and an anchor for the underlying artifacts that comprise the Backup (the config backup and VolumeBackups).
Backup.Types
Container for nested types declared in the Backup message type.
Backup.Types.ClusterMetadata
Information about the GKE cluster from which this Backup was created.
BackupForGKE
BackupForGKE allows Kubernetes administrators to configure, execute, and manage backup and restore operations for their GKE clusters.
BackupForGKE.BackupForGKEBase
Base class for server-side implementations of BackupForGKE
BackupForGKE.BackupForGKEClient
Client for BackupForGKE
BackupForGKEClient
BackupForGKE client wrapper, for convenient use.
BackupForGKEClientBuilder
Builder class for BackupForGKEClient to provide simple configuration of credentials, endpoint etc.
BackupForGKEClientImpl
BackupForGKE client wrapper implementation, for convenient use.
BackupForGKESettings
Settings for BackupForGKEClient instances.
BackupName
Resource name for the Backup resource.
BackupPlan
Defines the configuration and scheduling for a "line" of Backups.
BackupPlan.Types
Container for nested types declared in the BackupPlan message type.
BackupPlan.Types.BackupConfig
BackupConfig defines the configuration of Backups created via this BackupPlan.
BackupPlan.Types.RetentionPolicy
RetentionPolicy defines a Backup retention policy for a BackupPlan.
BackupPlan.Types.Schedule
Defines scheduling parameters for automatically creating Backups via this BackupPlan.
BackupPlanName
Resource name for the BackupPlan resource.
ClusterName
Resource name for the Cluster resource.
CreateBackupPlanRequest
Request message for CreateBackupPlan.
CreateBackupRequest
Request message for CreateBackup.
CreateRestorePlanRequest
Request message for CreateRestorePlan.
CreateRestoreRequest
Request message for CreateRestore.
CryptoKeyName
Resource name for the CryptoKey resource.
DeleteBackupPlanRequest
Request message for DeleteBackupPlan.
DeleteBackupRequest
Request message for DeleteBackup.
DeleteRestorePlanRequest
Request message for DeleteRestorePlan.
DeleteRestoreRequest
Request message for DeleteRestore.
EncryptionKey
Defined a customer managed encryption key that will be used to encrypt Backup artifacts.
ExclusionWindow
Defines a time window during which no backup should happen. All time and date are in UTC.
ExclusionWindow.Types
Container for nested types declared in the ExclusionWindow message type.
ExclusionWindow.Types.DayOfWeekList
Holds repeated DaysOfWeek values as a container.
GetBackupIndexDownloadUrlRequest
Request message for GetBackupIndexDownloadUrl.
GetBackupIndexDownloadUrlResponse
Response message for GetBackupIndexDownloadUrl.
GetBackupPlanRequest
Request message for GetBackupPlan.
GetBackupRequest
Request message for GetBackup.
GetRestorePlanRequest
Request message for GetRestorePlan.
GetRestoreRequest
Request message for GetRestore.
GetVolumeBackupRequest
Request message for GetVolumeBackup.
GetVolumeRestoreRequest
Request message for GetVolumeRestore.
ListBackupPlansRequest
Request message for ListBackupPlans.
ListBackupPlansResponse
Response message for ListBackupPlans.
ListBackupsRequest
Request message for ListBackups.
ListBackupsResponse
Response message for ListBackups.
ListRestorePlansRequest
Request message for ListRestorePlans.
ListRestorePlansResponse
Response message for ListRestorePlans.
ListRestoresRequest
Request message for ListRestores.
ListRestoresResponse
Response message for ListRestores.
ListVolumeBackupsRequest
Request message for ListVolumeBackups.
ListVolumeBackupsResponse
Response message for ListVolumeBackups.
ListVolumeRestoresRequest
Request message for ListVolumeRestores.
ListVolumeRestoresResponse
Response message for ListVolumeRestores.
NamespacedName
A reference to a namespaced resource in Kubernetes.
NamespacedNames
A list of namespaced Kubernetes resources.
Namespaces
A list of Kubernetes Namespaces
OperationMetadata
Represents the metadata of the long-running operation.
Restore
Represents both a request to Restore some portion of a Backup into a target GKE cluster and a record of the restore operation itself.
Restore.Types
Container for nested types declared in the Restore message type.
RestoreConfig
Configuration of a restore.
RestoreConfig.Types
Container for nested types declared in the RestoreConfig message type.
RestoreConfig.Types.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
RestoreConfig.Types.GroupKind
This is a direct map to the Kubernetes GroupKind type GroupKind and is used for identifying specific "types" of resources to restore.
RestoreConfig.Types.ResourceFilter
ResourceFilter specifies matching criteria to limit the scope of a change to a specific set of kubernetes resources that are selected for restoration from a backup.
RestoreConfig.Types.SubstitutionRule
A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup. A rule contains both filtering logic (which resources are subject to substitution) and substitution logic.
RestoreConfig.Types.TransformationRule
A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup. A rule contains both filtering logic (which resources are subject to transform) and transformation logic.
RestoreConfig.Types.TransformationRuleAction
TransformationRuleAction defines a TransformationRule action based on the JSON Patch RFC (https://www.rfc-editor.org/rfc/rfc6902)
RestoreConfig.Types.TransformationRuleAction.Types
Container for nested types declared in the TransformationRuleAction message type.
RestoreName
Resource name for the Restore resource.
RestorePlan
The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan.
RestorePlan.Types
Container for nested types declared in the RestorePlan message type.
RestorePlanName
Resource name for the RestorePlan resource.
RpoConfig
Defines RPO scheduling configuration for automatically creating Backups via this BackupPlan.
UpdateBackupPlanRequest
Request message for UpdateBackupPlan.
UpdateBackupRequest
Request message for UpdateBackup.
UpdateRestorePlanRequest
Request message for UpdateRestorePlan.
UpdateRestoreRequest
Request message for UpdateRestore.
VolumeBackup
Represents the backup of a specific persistent volume as a component of a Backup - both the record of the operation and a pointer to the underlying storage-specific artifacts.
VolumeBackup.Types
Container for nested types declared in the VolumeBackup message type.
VolumeBackupName
Resource name for the VolumeBackup resource.
VolumeRestore
Represents the operation of restoring a volume from a VolumeBackup.
VolumeRestore.Types
Container for nested types declared in the VolumeRestore message type.
VolumeRestoreName
Resource name for the VolumeRestore resource.
Enums
Backup.BackupScopeOneofCase
Enum of possible cases for the "backup_scope" oneof.
Backup.Types.ClusterMetadata.PlatformVersionOneofCase
Enum of possible cases for the "platform_version" oneof.
Backup.Types.State
State
BackupName.ResourceNameType
The possible contents of BackupName.
BackupPlan.Types.BackupConfig.BackupScopeOneofCase
Enum of possible cases for the "backup_scope" oneof.
BackupPlan.Types.State
State
BackupPlanName.ResourceNameType
The possible contents of BackupPlanName.
ClusterName.ResourceNameType
The possible contents of ClusterName.
CryptoKeyName.ResourceNameType
The possible contents of CryptoKeyName.
ExclusionWindow.RecurrenceOneofCase
Enum of possible cases for the "recurrence" oneof.
Restore.Types.State
Possible values for state of the Restore.
RestoreConfig.NamespacedResourceRestoreScopeOneofCase
Enum of possible cases for the "namespaced_resource_restore_scope" oneof.
RestoreConfig.Types.ClusterResourceConflictPolicy
Defines the behavior for handling the situation where cluster-scoped resources being restored already exist in the target cluster.
RestoreConfig.Types.NamespacedResourceRestoreMode
Defines the behavior for handling the situation where sets of namespaced resources being restored already exist in the target cluster.
RestoreConfig.Types.TransformationRuleAction.Types.Op
Possible values for operations of a transformation rule action.
RestoreConfig.Types.VolumeDataRestorePolicy
Defines how volume data should be restored.
RestoreName.ResourceNameType
The possible contents of RestoreName.
RestorePlan.Types.State
State
RestorePlanName.ResourceNameType
The possible contents of RestorePlanName.
VolumeBackup.Types.State
The current state of a VolumeBackup
VolumeBackup.Types.VolumeBackupFormat
Identifies the format used for the volume backup.
VolumeBackupName.ResourceNameType
The possible contents of VolumeBackupName.
VolumeRestore.Types.State
The current state of a VolumeRestore
VolumeRestore.Types.VolumeType
Supported volume types.
VolumeRestoreName.ResourceNameType
The possible contents of VolumeRestoreName.