gkebackup/v1 library
Backup for GKE API - v1
Backup for GKE is a managed Kubernetes workload backup and restore service for GKE clusters.
For more information, see cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke
Create an instance of BackupForGKEApi to access these resources:
Classes
- AuditConfig
- Specifies the audit configuration for a service.
- 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).
- BackupConfig
- BackupConfig defines the configuration of Backups created via this BackupPlan.
- BackupForGKEApi
- Backup for GKE is a managed Kubernetes workload backup and restore service for GKE clusters.
- BackupPlan
- Defines the configuration and scheduling for a "line" of Backups.
- Binding
-
Associates
members
, or principals, with arole
. - ClusterMetadata
- Information about the GKE cluster from which this Backup was created.
- ClusterResourceRestoreScope
- Defines the scope of cluster-scoped resources to restore.
- DayOfWeekList
- Holds repeated DaysOfWeek values as a container.
- 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.
- Filter
-
Defines the filter for
Restore
. - GetBackupIndexDownloadUrlResponse
- Response message for GetBackupIndexDownloadUrl.
- GoogleLongrunningListOperationsResponse
- The response message for Operations.ListOperations.
- GoogleLongrunningOperation
- This resource represents a long-running operation that is the result of a network API call.
- GroupKind
- This is a direct map to the Kubernetes GroupKind type GroupKind and is used for identifying specific "types" of resources to restore.
- GroupKindDependency
- Defines a dependency between two group kinds.
- ListBackupPlansResponse
- Response message for ListBackupPlans.
- ListBackupsResponse
- Response message for ListBackups.
- ListLocationsResponse
- The response message for Locations.ListLocations.
- ListRestorePlansResponse
- Response message for ListRestorePlans.
- ListRestoresResponse
- Response message for ListRestores.
- ListVolumeBackupsResponse
- Response message for ListVolumeBackups.
- 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
- Policy
- An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
- ProjectsLocationsBackupPlansBackupsResource
- ProjectsLocationsBackupPlansBackupsVolumeBackupsResource
- ProjectsLocationsBackupPlansResource
- ProjectsLocationsOperationsResource
- ProjectsLocationsResource
- ProjectsLocationsRestorePlansResource
- ProjectsLocationsRestorePlansRestoresResource
- ProjectsLocationsRestorePlansRestoresVolumeRestoresResource
- ProjectsResource
- 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.
- ResourceSelector
- Defines a selector to identify a single or a group of resources.
- 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.
- RestoreConfig
- Configuration of a restore.
- RestoreOrder
- Allows customers to specify dependencies between resources that Backup for GKE can use to compute a resasonable restore order.
- RestorePlan
- The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan.
- RetentionPolicy
- RetentionPolicy defines a Backup retention policy for a BackupPlan.
- RpoConfig
- Defines RPO scheduling configuration for automatically creating Backups via this BackupPlan.
- Schedule
- Defines scheduling parameters for automatically creating Backups via this BackupPlan.
- SetIamPolicyRequest
-
Request message for
SetIamPolicy
method. - SubstitutionRule
- A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup.
- TransformationRule
- A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup.
- TransformationRuleAction
- TransformationRuleAction defines a TransformationRule action based on the JSON Patch RFC (https://www.rfc-editor.org/rfc/rfc6902)
- 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.
- VolumeDataRestorePolicyBinding
- Binds resources in the scope to the given VolumeDataRestorePolicy.
- VolumeDataRestorePolicyOverride
- Defines an override to apply a VolumeDataRestorePolicy for scoped resources.
- VolumeRestore
- Represents the operation of restoring a volume from a VolumeBackup.
Typedefs
- AuditLogConfig = $AuditLogConfig
- Provides the configuration for logging a type of permissions.
- Date = $Date
- Represents a whole or partial calendar date, such as a birthday.
- Empty = $Empty
- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
- Expr = $Expr
- Represents a textual expression in the Common Expression Language (CEL) syntax.
- GoogleLongrunningCancelOperationRequest = $Empty
- The request message for Operations.CancelOperation.
- GoogleRpcStatus = $Status
-
The
Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. - Location = $Location00
- A resource that represents a Google Cloud location.
- TestIamPermissionsRequest = $TestIamPermissionsRequest00
-
Request message for
TestIamPermissions
method. - TestIamPermissionsResponse = $PermissionsResponse
-
Response message for
TestIamPermissions
method. - TimeOfDay = $TimeOfDay
- Represents a time of day.
Exceptions / Errors
- ApiRequestError
- Represents a general error reported by the API endpoint.
- DetailedApiRequestError
- Represents a specific error reported by the API endpoint.