Package com.google.cloud.gkebackup.v1 (0.8.0)

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);
 }

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). Next id: 28

Protobuf type google.cloud.gkebackup.v1.Backup

Backup.Builder

Protobuf type google.cloud.gkebackup.v1.Backup

Backup.ClusterMetadata

Information about the GKE cluster from which this Backup was created.

Protobuf type google.cloud.gkebackup.v1.Backup.ClusterMetadata

Backup.ClusterMetadata.Builder

Information about the GKE cluster from which this Backup was created.

Protobuf type google.cloud.gkebackup.v1.Backup.ClusterMetadata

BackupForGKEClient

Service Description: BackupForGKE allows Kubernetes administrators to configure, execute, and manage backup and restore operations for their GKE clusters.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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);
 }

Note: close() needs to be called on the BackupForGKEClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of BackupForGKESettings to create(). For example:

To customize credentials:


 // 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
 BackupForGKESettings backupForGKESettings =
     BackupForGKESettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BackupForGKEClient backupForGKEClient = BackupForGKEClient.create(backupForGKESettings);

To customize the endpoint:


 // 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
 BackupForGKESettings backupForGKESettings =
     BackupForGKESettings.newBuilder().setEndpoint(myEndpoint).build();
 BackupForGKEClient backupForGKEClient = BackupForGKEClient.create(backupForGKESettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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
 BackupForGKESettings backupForGKESettings = BackupForGKESettings.newHttpJsonBuilder().build();
 BackupForGKEClient backupForGKEClient = BackupForGKEClient.create(backupForGKESettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

BackupForGKEClient.ListBackupPlansFixedSizeCollection

BackupForGKEClient.ListBackupPlansPage

BackupForGKEClient.ListBackupPlansPagedResponse

BackupForGKEClient.ListBackupsFixedSizeCollection

BackupForGKEClient.ListBackupsPage

BackupForGKEClient.ListBackupsPagedResponse

BackupForGKEClient.ListRestorePlansFixedSizeCollection

BackupForGKEClient.ListRestorePlansPage

BackupForGKEClient.ListRestorePlansPagedResponse

BackupForGKEClient.ListRestoresFixedSizeCollection

BackupForGKEClient.ListRestoresPage

BackupForGKEClient.ListRestoresPagedResponse

BackupForGKEClient.ListVolumeBackupsFixedSizeCollection

BackupForGKEClient.ListVolumeBackupsPage

BackupForGKEClient.ListVolumeBackupsPagedResponse