@Generated("by gapic-generator-java")
Package com.google.cloud.gkebackup.v1
A client to Backup for GKE API
The interfaces provided are listed below, along with usage samples.
======================= BackupForGKEClient =======================
Service Description: BackupForGKE allows Kubernetes administrators to configure, execute, and manage backup and restore operations for their GKE clusters.
Sample for BackupForGKEClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (BackupForGKEClient backupForGKEClient = BackupForGKEClient.create()) {
BackupPlanName name = BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]");
BackupPlan response = backupForGKEClient.getBackupPlan(name);
}
-
Class Summary Class Description 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.Builder 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.ClusterMetadata Information about the GKE cluster from which this Backup was created.Backup.ClusterMetadata.Builder Information about the GKE cluster from which this Backup was created.BackupForGKEClient Service Description: BackupForGKE allows Kubernetes administrators to configure, execute, and manage backup and restore operations for their GKE clusters.BackupForGKEClient.ListBackupPlansFixedSizeCollection BackupForGKEClient.ListBackupPlansPage BackupForGKEClient.ListBackupPlansPagedResponse BackupForGKEClient.ListBackupsFixedSizeCollection BackupForGKEClient.ListBackupsPage BackupForGKEClient.ListBackupsPagedResponse BackupForGKEClient.ListLocationsFixedSizeCollection BackupForGKEClient.ListLocationsPage BackupForGKEClient.ListLocationsPagedResponse BackupForGKEClient.ListRestorePlansFixedSizeCollection BackupForGKEClient.ListRestorePlansPage BackupForGKEClient.ListRestorePlansPagedResponse BackupForGKEClient.ListRestoresFixedSizeCollection BackupForGKEClient.ListRestoresPage BackupForGKEClient.ListRestoresPagedResponse BackupForGKEClient.ListVolumeBackupsFixedSizeCollection BackupForGKEClient.ListVolumeBackupsPage BackupForGKEClient.ListVolumeBackupsPagedResponse BackupForGKEClient.ListVolumeRestoresFixedSizeCollection BackupForGKEClient.ListVolumeRestoresPage BackupForGKEClient.ListVolumeRestoresPagedResponse BackupForGKEGrpc BackupForGKE allows Kubernetes administrators to configure, execute, and manage backup and restore operations for their GKE clusters.BackupForGKEGrpc.BackupForGKEBlockingStub A stub to allow clients to do synchronous rpc calls to service BackupForGKE.BackupForGKEGrpc.BackupForGKEFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service BackupForGKE.BackupForGKEGrpc.BackupForGKEImplBase Base class for the server implementation of the service BackupForGKE.BackupForGKEGrpc.BackupForGKEStub A stub to allow clients to do asynchronous rpc calls to service BackupForGKE.BackupForGKESettings Settings class to configure an instance ofBackupForGKEClient
.BackupForGKESettings.Builder Builder for BackupForGKESettings.BackupName BackupName.Builder Builder for projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}.BackupPlan Defines the configuration and scheduling for a "line" of Backups.BackupPlan.BackupConfig BackupConfig defines the configuration of Backups created via this BackupPlan.BackupPlan.BackupConfig.Builder BackupConfig defines the configuration of Backups created via this BackupPlan.BackupPlan.Builder Defines the configuration and scheduling for a "line" of Backups.BackupPlan.RetentionPolicy RetentionPolicy defines a Backup retention policy for a BackupPlan.BackupPlan.RetentionPolicy.Builder RetentionPolicy defines a Backup retention policy for a BackupPlan.BackupPlan.Schedule Defines scheduling parameters for automatically creating Backups via this BackupPlan.BackupPlan.Schedule.Builder Defines scheduling parameters for automatically creating Backups via this BackupPlan.BackupPlanName BackupPlanName.Builder Builder for projects/{project}/locations/{location}/backupPlans/{backup_plan}.BackupPlanProto BackupProto CommonProto CreateBackupPlanRequest Request message for CreateBackupPlan.CreateBackupPlanRequest.Builder Request message for CreateBackupPlan.CreateBackupRequest Request message for CreateBackup.CreateBackupRequest.Builder Request message for CreateBackup.CreateRestorePlanRequest Request message for CreateRestorePlan.CreateRestorePlanRequest.Builder Request message for CreateRestorePlan.CreateRestoreRequest Request message for CreateRestore.CreateRestoreRequest.Builder Request message for CreateRestore.DeleteBackupPlanRequest Request message for DeleteBackupPlan.DeleteBackupPlanRequest.Builder Request message for DeleteBackupPlan.DeleteBackupRequest Request message for DeleteBackup.DeleteBackupRequest.Builder Request message for DeleteBackup.DeleteRestorePlanRequest Request message for DeleteRestorePlan.DeleteRestorePlanRequest.Builder Request message for DeleteRestorePlan.DeleteRestoreRequest Request message for DeleteRestore.DeleteRestoreRequest.Builder Request message for DeleteRestore.EncryptionKey Defined a customer managed encryption key that will be used to encrypt Backup artifacts.EncryptionKey.Builder Defined a customer managed encryption key that will be used to encrypt Backup artifacts.GetBackupPlanRequest Request message for GetBackupPlan.GetBackupPlanRequest.Builder Request message for GetBackupPlan.GetBackupRequest Request message for GetBackup.GetBackupRequest.Builder Request message for GetBackup.GetRestorePlanRequest Request message for GetRestorePlan.GetRestorePlanRequest.Builder Request message for GetRestorePlan.GetRestoreRequest Request message for GetRestore.GetRestoreRequest.Builder Request message for GetRestore.GetVolumeBackupRequest Request message for GetVolumeBackup.GetVolumeBackupRequest.Builder Request message for GetVolumeBackup.GetVolumeRestoreRequest Request message for GetVolumeRestore.GetVolumeRestoreRequest.Builder Request message for GetVolumeRestore.GKEBackupProto ListBackupPlansRequest Request message for ListBackupPlans.ListBackupPlansRequest.Builder Request message for ListBackupPlans.ListBackupPlansResponse Response message for ListBackupPlans.ListBackupPlansResponse.Builder Response message for ListBackupPlans.ListBackupsRequest Request message for ListBackups.ListBackupsRequest.Builder Request message for ListBackups.ListBackupsResponse Response message for ListBackups.ListBackupsResponse.Builder Response message for ListBackups.ListRestorePlansRequest Request message for ListRestorePlans.ListRestorePlansRequest.Builder Request message for ListRestorePlans.ListRestorePlansResponse Response message for ListRestorePlans.ListRestorePlansResponse.Builder Response message for ListRestorePlans.ListRestoresRequest Request message for ListRestores.ListRestoresRequest.Builder Request message for ListRestores.ListRestoresResponse Response message for ListRestores.ListRestoresResponse.Builder Response message for ListRestores.ListVolumeBackupsRequest Request message for ListVolumeBackups.ListVolumeBackupsRequest.Builder Request message for ListVolumeBackups.ListVolumeBackupsResponse Response message for ListVolumeBackups.ListVolumeBackupsResponse.Builder Response message for ListVolumeBackups.ListVolumeRestoresRequest Request message for ListVolumeRestores.ListVolumeRestoresRequest.Builder Request message for ListVolumeRestores.ListVolumeRestoresResponse Response message for ListVolumeRestores.ListVolumeRestoresResponse.Builder Response message for ListVolumeRestores.LocationName LocationName.Builder Builder for projects/{project}/locations/{location}.NamespacedName A reference to a namespaced resource in Kubernetes.NamespacedName.Builder A reference to a namespaced resource in Kubernetes.NamespacedNames A list of namespaced Kubernetes resources.NamespacedNames.Builder A list of namespaced Kubernetes resources.Namespaces A list of Kubernetes NamespacesNamespaces.Builder A list of Kubernetes NamespacesOperationMetadata Represents the metadata of the long-running operation.OperationMetadata.Builder 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.Builder 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.RestoreConfig.Builder Configuration of a restore.RestoreConfig.ClusterResourceRestoreScope Defines the scope of cluster-scoped resources to restore.RestoreConfig.ClusterResourceRestoreScope.Builder Defines the scope of cluster-scoped resources to restore.RestoreConfig.GroupKind This is a direct map to the Kubernetes GroupKind type [GroupKind](https://godoc.org/k8s.io/apimachinery/pkg/runtime/schema#GroupKind) and is used for identifying specific "types" of resources to restore.RestoreConfig.GroupKind.Builder This is a direct map to the Kubernetes GroupKind type [GroupKind](https://godoc.org/k8s.io/apimachinery/pkg/runtime/schema#GroupKind) and is used for identifying specific "types" of resources to restore.RestoreConfig.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.ResourceFilter.Builder 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.SubstitutionRule A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup.RestoreConfig.SubstitutionRule.Builder A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup.RestoreConfig.TransformationRule A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup.RestoreConfig.TransformationRule.Builder A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup.RestoreConfig.TransformationRuleAction TransformationRuleAction defines a TransformationRule action based on the JSON Patch RFC (https://www.rfc-editor.org/rfc/rfc6902)RestoreConfig.TransformationRuleAction.Builder TransformationRuleAction defines a TransformationRule action based on the JSON Patch RFC (https://www.rfc-editor.org/rfc/rfc6902)RestoreName RestoreName.Builder Builder for projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}.RestorePlan The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan.RestorePlan.Builder The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan.RestorePlanName RestorePlanName.Builder Builder for projects/{project}/locations/{location}/restorePlans/{restore_plan}.RestorePlanProto RestoreProto UpdateBackupPlanRequest Request message for UpdateBackupPlan.UpdateBackupPlanRequest.Builder Request message for UpdateBackupPlan.UpdateBackupRequest Request message for UpdateBackup.UpdateBackupRequest.Builder Request message for UpdateBackup.UpdateRestorePlanRequest Request message for UpdateRestorePlan.UpdateRestorePlanRequest.Builder Request message for UpdateRestorePlan.UpdateRestoreRequest Request message for UpdateRestore.UpdateRestoreRequest.Builder 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.Builder 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.VolumeBackupName VolumeBackupName.Builder Builder for projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}/volumeBackups/{volume_backup}.VolumeProto VolumeRestore Represents the operation of restoring a volume from a VolumeBackup.VolumeRestore.Builder Represents the operation of restoring a volume from a VolumeBackup.VolumeRestoreName VolumeRestoreName.Builder Builder for projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}/volumeRestores/{volume_restore}. -
Enum Summary Enum Description Backup.BackupScopeCase Backup.ClusterMetadata.PlatformVersionCase Backup.State StateBackupPlan.BackupConfig.BackupScopeCase BackupPlan.State StateRestore.State Possible values for state of the Restore.RestoreConfig.ClusterResourceConflictPolicy Defines the behavior for handling the situation where cluster-scoped resources being restored already exist in the target cluster.RestoreConfig.NamespacedResourceRestoreMode Defines the behavior for handling the situation where sets of namespaced resources being restored already exist in the target cluster.RestoreConfig.NamespacedResourceRestoreScopeCase RestoreConfig.TransformationRuleAction.Op Possible values for operations of a transformation rule action.RestoreConfig.VolumeDataRestorePolicy Defines how volume data should be restored.RestorePlan.State StateVolumeBackup.State The current state of a VolumeBackupVolumeBackup.VolumeBackupFormat Identifies the format used for the volume backup.VolumeRestore.State The current state of a VolumeRestoreVolumeRestore.VolumeType Supported volume types.