Class BackupForGKEClient (0.94.0)

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().

Methods
Method	Description	Method Variants
CreateBackupPlan	Creates a new BackupPlan in a given location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createBackupPlanAsync(CreateBackupPlanRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createBackupPlanAsync(LocationName parent, BackupPlan backupPlan, String backupPlanId) createBackupPlanAsync(String parent, BackupPlan backupPlan, String backupPlanId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createBackupPlanOperationCallable() createBackupPlanCallable()
ListBackupPlans	Lists BackupPlans in a given location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listBackupPlans(ListBackupPlansRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listBackupPlans(LocationName parent) listBackupPlans(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listBackupPlansPagedCallable() listBackupPlansCallable()
GetBackupPlan	Retrieve the details of a single BackupPlan.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getBackupPlan(GetBackupPlanRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getBackupPlan(BackupPlanName name) getBackupPlan(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getBackupPlanCallable()
UpdateBackupPlan	Update a BackupPlan.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateBackupPlanAsync(UpdateBackupPlanRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateBackupPlanAsync(BackupPlan backupPlan, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateBackupPlanOperationCallable() updateBackupPlanCallable()
DeleteBackupPlan	Deletes an existing BackupPlan.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteBackupPlanAsync(DeleteBackupPlanRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteBackupPlanAsync(BackupPlanName name) deleteBackupPlanAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteBackupPlanOperationCallable() deleteBackupPlanCallable()
CreateBackupChannel	Creates a new BackupChannel in a given location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createBackupChannelAsync(CreateBackupChannelRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createBackupChannelAsync(LocationName parent, BackupChannel backupChannel, String backupChannelId) createBackupChannelAsync(String parent, BackupChannel backupChannel, String backupChannelId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createBackupChannelOperationCallable() createBackupChannelCallable()
ListBackupChannels	Lists BackupChannels in a given location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listBackupChannels(ListBackupChannelsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listBackupChannels(LocationName parent) listBackupChannels(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listBackupChannelsPagedCallable() listBackupChannelsCallable()
GetBackupChannel	Retrieve the details of a single BackupChannel.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getBackupChannel(GetBackupChannelRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getBackupChannel(BackupChannelName name) getBackupChannel(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getBackupChannelCallable()
UpdateBackupChannel	Update a BackupChannel.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateBackupChannelAsync(UpdateBackupChannelRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateBackupChannelAsync(BackupChannel backupChannel, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateBackupChannelOperationCallable() updateBackupChannelCallable()
DeleteBackupChannel	Deletes an existing BackupChannel.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteBackupChannelAsync(DeleteBackupChannelRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteBackupChannelAsync(BackupChannelName name) deleteBackupChannelAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteBackupChannelOperationCallable() deleteBackupChannelCallable()
ListBackupPlanBindings	Lists BackupPlanBindings in a given location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listBackupPlanBindings(ListBackupPlanBindingsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listBackupPlanBindings(BackupChannelName parent) listBackupPlanBindings(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listBackupPlanBindingsPagedCallable() listBackupPlanBindingsCallable()
GetBackupPlanBinding	Retrieve the details of a single BackupPlanBinding.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getBackupPlanBinding(GetBackupPlanBindingRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getBackupPlanBinding(BackupPlanBindingName name) getBackupPlanBinding(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getBackupPlanBindingCallable()
CreateBackup	Creates a Backup for the given BackupPlan.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createBackupAsync(CreateBackupRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createBackupAsync(BackupPlanName parent, Backup backup, String backupId) createBackupAsync(String parent, Backup backup, String backupId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createBackupOperationCallable() createBackupCallable()
ListBackups	Lists the Backups for a given BackupPlan.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listBackups(ListBackupsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listBackups(BackupPlanName parent) listBackups(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listBackupsPagedCallable() listBackupsCallable()
GetBackup	Retrieve the details of a single Backup.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getBackup(GetBackupRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getBackup(BackupName name) getBackup(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getBackupCallable()
UpdateBackup	Update a Backup.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateBackupAsync(UpdateBackupRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateBackupAsync(Backup backup, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateBackupOperationCallable() updateBackupCallable()
DeleteBackup	Deletes an existing Backup.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteBackupAsync(DeleteBackupRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteBackupAsync(BackupName name) deleteBackupAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteBackupOperationCallable() deleteBackupCallable()
ListVolumeBackups	Lists the VolumeBackups for a given Backup.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listVolumeBackups(ListVolumeBackupsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listVolumeBackups(BackupName parent) listVolumeBackups(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listVolumeBackupsPagedCallable() listVolumeBackupsCallable()
GetVolumeBackup	Retrieve the details of a single VolumeBackup.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getVolumeBackup(GetVolumeBackupRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getVolumeBackup(VolumeBackupName name) getVolumeBackup(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getVolumeBackupCallable()
CreateRestorePlan	Creates a new RestorePlan in a given location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createRestorePlanAsync(CreateRestorePlanRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createRestorePlanAsync(LocationName parent, RestorePlan restorePlan, String restorePlanId) createRestorePlanAsync(String parent, RestorePlan restorePlan, String restorePlanId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createRestorePlanOperationCallable() createRestorePlanCallable()
ListRestorePlans	Lists RestorePlans in a given location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listRestorePlans(ListRestorePlansRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listRestorePlans(LocationName parent) listRestorePlans(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listRestorePlansPagedCallable() listRestorePlansCallable()
GetRestorePlan	Retrieve the details of a single RestorePlan.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getRestorePlan(GetRestorePlanRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getRestorePlan(RestorePlanName name) getRestorePlan(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getRestorePlanCallable()
UpdateRestorePlan	Update a RestorePlan.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateRestorePlanAsync(UpdateRestorePlanRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateRestorePlanAsync(RestorePlan restorePlan, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateRestorePlanOperationCallable() updateRestorePlanCallable()
DeleteRestorePlan	Deletes an existing RestorePlan.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteRestorePlanAsync(DeleteRestorePlanRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteRestorePlanAsync(RestorePlanName name) deleteRestorePlanAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteRestorePlanOperationCallable() deleteRestorePlanCallable()
CreateRestoreChannel	Creates a new RestoreChannel in a given location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createRestoreChannelAsync(CreateRestoreChannelRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createRestoreChannelAsync(LocationName parent, RestoreChannel restoreChannel, String restoreChannelId) createRestoreChannelAsync(String parent, RestoreChannel restoreChannel, String restoreChannelId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createRestoreChannelOperationCallable() createRestoreChannelCallable()
ListRestoreChannels	Lists RestoreChannels in a given location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listRestoreChannels(ListRestoreChannelsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listRestoreChannels(LocationName parent) listRestoreChannels(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listRestoreChannelsPagedCallable() listRestoreChannelsCallable()
GetRestoreChannel	Retrieve the details of a single RestoreChannel.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getRestoreChannel(GetRestoreChannelRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getRestoreChannel(RestoreChannelName name) getRestoreChannel(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getRestoreChannelCallable()
UpdateRestoreChannel	Update a RestoreChannel.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateRestoreChannelAsync(UpdateRestoreChannelRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateRestoreChannelAsync(RestoreChannel restoreChannel, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateRestoreChannelOperationCallable() updateRestoreChannelCallable()
DeleteRestoreChannel	Deletes an existing RestoreChannel.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteRestoreChannelAsync(DeleteRestoreChannelRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteRestoreChannelAsync(RestoreChannelName name) deleteRestoreChannelAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteRestoreChannelOperationCallable() deleteRestoreChannelCallable()
ListRestorePlanBindings	Lists RestorePlanBindings in a given location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listRestorePlanBindings(ListRestorePlanBindingsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listRestorePlanBindings(RestoreChannelName parent) listRestorePlanBindings(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listRestorePlanBindingsPagedCallable() listRestorePlanBindingsCallable()
GetRestorePlanBinding	Retrieve the details of a single RestorePlanBinding.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getRestorePlanBinding(GetRestorePlanBindingRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getRestorePlanBinding(RestorePlanBindingName name) getRestorePlanBinding(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getRestorePlanBindingCallable()
CreateRestore	Creates a new Restore for the given RestorePlan.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createRestoreAsync(CreateRestoreRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createRestoreAsync(RestorePlanName parent, Restore restore, String restoreId) createRestoreAsync(String parent, Restore restore, String restoreId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createRestoreOperationCallable() createRestoreCallable()
ListRestores	Lists the Restores for a given RestorePlan.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listRestores(ListRestoresRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listRestores(RestorePlanName parent) listRestores(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listRestoresPagedCallable() listRestoresCallable()
GetRestore	Retrieves the details of a single Restore.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getRestore(GetRestoreRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getRestore(RestoreName name) getRestore(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getRestoreCallable()
UpdateRestore	Update a Restore.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateRestoreAsync(UpdateRestoreRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateRestoreAsync(Restore restore, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateRestoreOperationCallable() updateRestoreCallable()
DeleteRestore	Deletes an existing Restore.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteRestoreAsync(DeleteRestoreRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteRestoreAsync(RestoreName name) deleteRestoreAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteRestoreOperationCallable() deleteRestoreCallable()
ListVolumeRestores	Lists the VolumeRestores for a given Restore.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listVolumeRestores(ListVolumeRestoresRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listVolumeRestores(RestoreName parent) listVolumeRestores(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listVolumeRestoresPagedCallable() listVolumeRestoresCallable()
GetVolumeRestore	Retrieve the details of a single VolumeRestore.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getVolumeRestore(GetVolumeRestoreRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getVolumeRestore(VolumeRestoreName name) getVolumeRestore(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getVolumeRestoreCallable()
GetBackupIndexDownloadUrl	Retrieve the link to the backupIndex.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getBackupIndexDownloadUrl(GetBackupIndexDownloadUrlRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getBackupIndexDownloadUrl(BackupName backup) getBackupIndexDownloadUrl(String backup) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getBackupIndexDownloadUrlCallable()
ListLocations	Lists information about the supported locations for this service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()
SetIamPolicy	Sets the access control policy on the specified resource. Replacesany existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
GetIamPolicy	Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
TestIamPermissions	Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()

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.

Inheritance

java.lang.Object > BackupForGKEClient

Static Methods

create()

public static final BackupForGKEClient create()

Constructs an instance of BackupForGKEClient with default settings.

Returns
Type	Description
`BackupForGKEClient`

Exceptions
Type	Description
`IOException`

create(BackupForGKESettings settings)

public static final BackupForGKEClient create(BackupForGKESettings settings)

Constructs an instance of BackupForGKEClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
`settings`	`BackupForGKESettings`

Returns
Type	Description
`BackupForGKEClient`

Exceptions
Type	Description
`IOException`

create(BackupForGKEStub stub)

public static final BackupForGKEClient create(BackupForGKEStub stub)

Constructs an instance of BackupForGKEClient, using the given stub for making calls. This is for advanced usage - prefer using create(BackupForGKESettings).

Parameter
Name	Description
`stub`	`BackupForGKEStub`

Returns
Type	Description
`BackupForGKEClient`

Constructors

BackupForGKEClient(BackupForGKESettings settings)

protected BackupForGKEClient(BackupForGKESettings settings)

Constructs an instance of BackupForGKEClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name	Description
`settings`	`BackupForGKESettings`

BackupForGKEClient(BackupForGKEStub stub)

protected BackupForGKEClient(BackupForGKEStub stub)

Parameter
Name	Description
`stub`	`BackupForGKEStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

createBackupAsync(@Nullable BackupPlanName parent, Backup backup, String backupId)

public final OperationFuture<Backup,OperationMetadata> createBackupAsync(@Nullable BackupPlanName parent, Backup backup, String backupId)

Creates a Backup for the given BackupPlan.

Sample code:


 // 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 parent = BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]");
   Backup backup = Backup.newBuilder().build();
   String backupId = "backupId2121930365";
   Backup response = backupForGKEClient.createBackupAsync(parent, backup, backupId).get();
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.BackupPlanName` Required. The BackupPlan within which to create the Backup. Format: `projects//locations//backupPlans/*`
`backup`	`Backup` Optional. The Backup resource to create.
`backupId`	`String` Optional. The client-provided short name for the Backup resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Backups in this BackupPlan

Returns
Type	Description
`OperationFuture<Backup,OperationMetadata>`

createBackupAsync(CreateBackupRequest request)

public final OperationFuture<Backup,OperationMetadata> createBackupAsync(CreateBackupRequest request)

Creates a Backup for the given BackupPlan.

Sample code:


 // 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()) {
   CreateBackupRequest request =
       CreateBackupRequest.newBuilder()
           .setParent(BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]").toString())
           .setBackup(Backup.newBuilder().build())
           .setBackupId("backupId2121930365")
           .build();
   Backup response = backupForGKEClient.createBackupAsync(request).get();
 }

Parameter
Name	Description
`request`	`CreateBackupRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Backup,OperationMetadata>`

createBackupAsync(String parent, Backup backup, String backupId)

public final OperationFuture<Backup,OperationMetadata> createBackupAsync(String parent, Backup backup, String backupId)

Creates a Backup for the given BackupPlan.

Sample code:


 // 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()) {
   String parent = BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]").toString();
   Backup backup = Backup.newBuilder().build();
   String backupId = "backupId2121930365";
   Backup response = backupForGKEClient.createBackupAsync(parent, backup, backupId).get();
 }

Parameters
Name	Description
`parent`	`String` Required. The BackupPlan within which to create the Backup. Format: `projects//locations//backupPlans/*`
`backup`	`Backup` Optional. The Backup resource to create.
`backupId`	`String` Optional. The client-provided short name for the Backup resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Backups in this BackupPlan

Returns
Type	Description
`OperationFuture<Backup,OperationMetadata>`

createBackupCallable()

public final UnaryCallable<CreateBackupRequest,Operation> createBackupCallable()

Creates a Backup for the given BackupPlan.

Sample code:


 // 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()) {
   CreateBackupRequest request =
       CreateBackupRequest.newBuilder()
           .setParent(BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]").toString())
           .setBackup(Backup.newBuilder().build())
           .setBackupId("backupId2121930365")
           .build();
   ApiFuture<Operation> future = backupForGKEClient.createBackupCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateBackupRequest,Operation>`

createBackupChannelAsync(@Nullable LocationName parent, BackupChannel backupChannel, String backupChannelId)

public final OperationFuture<BackupChannel,OperationMetadata> createBackupChannelAsync(@Nullable LocationName parent, BackupChannel backupChannel, String backupChannelId)

Creates a new BackupChannel in a given location.

Sample code:


 // 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()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   BackupChannel backupChannel = BackupChannel.newBuilder().build();
   String backupChannelId = "backupChannelId707614172";
   BackupChannel response =
       backupForGKEClient.createBackupChannelAsync(parent, backupChannel, backupChannelId).get();
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.LocationName` Required. The location within which to create the BackupChannel. Format: `projects//locations/`
`backupChannel`	`BackupChannel` Required. The BackupChannel resource object to create.
`backupChannelId`	`String` Optional. The client-provided short name for the BackupChannel resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupChannels in this location If the user does not provide a name, a uuid will be used as the name.

Returns
Type	Description
`OperationFuture<BackupChannel,OperationMetadata>`

createBackupChannelAsync(CreateBackupChannelRequest request)

public final OperationFuture<BackupChannel,OperationMetadata> createBackupChannelAsync(CreateBackupChannelRequest request)

Creates a new BackupChannel in a given location.

Sample code:


 // 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()) {
   CreateBackupChannelRequest request =
       CreateBackupChannelRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setBackupChannel(BackupChannel.newBuilder().build())
           .setBackupChannelId("backupChannelId707614172")
           .build();
   BackupChannel response = backupForGKEClient.createBackupChannelAsync(request).get();
 }

Parameter
Name	Description
`request`	`CreateBackupChannelRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<BackupChannel,OperationMetadata>`

createBackupChannelAsync(String parent, BackupChannel backupChannel, String backupChannelId)

public final OperationFuture<BackupChannel,OperationMetadata> createBackupChannelAsync(String parent, BackupChannel backupChannel, String backupChannelId)

Creates a new BackupChannel in a given location.

Sample code:


 // 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()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   BackupChannel backupChannel = BackupChannel.newBuilder().build();
   String backupChannelId = "backupChannelId707614172";
   BackupChannel response =
       backupForGKEClient.createBackupChannelAsync(parent, backupChannel, backupChannelId).get();
 }

Parameters
Name	Description
`parent`	`String` Required. The location within which to create the BackupChannel. Format: `projects//locations/`
`backupChannel`	`BackupChannel` Required. The BackupChannel resource object to create.
`backupChannelId`	`String` Optional. The client-provided short name for the BackupChannel resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupChannels in this location If the user does not provide a name, a uuid will be used as the name.

Returns
Type	Description
`OperationFuture<BackupChannel,OperationMetadata>`

createBackupChannelCallable()

public final UnaryCallable<CreateBackupChannelRequest,Operation> createBackupChannelCallable()

Creates a new BackupChannel in a given location.

Sample code:


 // 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()) {
   CreateBackupChannelRequest request =
       CreateBackupChannelRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setBackupChannel(BackupChannel.newBuilder().build())
           .setBackupChannelId("backupChannelId707614172")
           .build();
   ApiFuture<Operation> future =
       backupForGKEClient.createBackupChannelCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateBackupChannelRequest,Operation>`

createBackupChannelOperationCallable()

public final OperationCallable<CreateBackupChannelRequest,BackupChannel,OperationMetadata> createBackupChannelOperationCallable()

Creates a new BackupChannel in a given location.

Sample code:


 // 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()) {
   CreateBackupChannelRequest request =
       CreateBackupChannelRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setBackupChannel(BackupChannel.newBuilder().build())
           .setBackupChannelId("backupChannelId707614172")
           .build();
   OperationFuture<BackupChannel, OperationMetadata> future =
       backupForGKEClient.createBackupChannelOperationCallable().futureCall(request);
   // Do something.
   BackupChannel response = future.get();
 }

Returns
Type	Description
`OperationCallable<CreateBackupChannelRequest,BackupChannel,OperationMetadata>`

createBackupOperationCallable()

public final OperationCallable<CreateBackupRequest,Backup,OperationMetadata> createBackupOperationCallable()

Creates a Backup for the given BackupPlan.

Sample code:


 // 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()) {
   CreateBackupRequest request =
       CreateBackupRequest.newBuilder()
           .setParent(BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]").toString())
           .setBackup(Backup.newBuilder().build())
           .setBackupId("backupId2121930365")
           .build();
   OperationFuture<Backup, OperationMetadata> future =
       backupForGKEClient.createBackupOperationCallable().futureCall(request);
   // Do something.
   Backup response = future.get();
 }

Returns
Type	Description
`OperationCallable<CreateBackupRequest,Backup,OperationMetadata>`

createBackupPlanAsync(@Nullable LocationName parent, BackupPlan backupPlan, String backupPlanId)

public final OperationFuture<BackupPlan,OperationMetadata> createBackupPlanAsync(@Nullable LocationName parent, BackupPlan backupPlan, String backupPlanId)

Creates a new BackupPlan in a given location.

Sample code:


 // 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()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   BackupPlan backupPlan = BackupPlan.newBuilder().build();
   String backupPlanId = "backupPlanId-84871546";
   BackupPlan response =
       backupForGKEClient.createBackupPlanAsync(parent, backupPlan, backupPlanId).get();
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.LocationName` Required. The location within which to create the BackupPlan. Format: `projects//locations/`
`backupPlan`	`BackupPlan` Required. The BackupPlan resource object to create.
`backupPlanId`	`String` Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location

Returns
Type	Description
`OperationFuture<BackupPlan,OperationMetadata>`

createBackupPlanAsync(CreateBackupPlanRequest request)

public final OperationFuture<BackupPlan,OperationMetadata> createBackupPlanAsync(CreateBackupPlanRequest request)

Creates a new BackupPlan in a given location.

Sample code:


 // 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()) {
   CreateBackupPlanRequest request =
       CreateBackupPlanRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setBackupPlan(BackupPlan.newBuilder().build())
           .setBackupPlanId("backupPlanId-84871546")
           .build();
   BackupPlan response = backupForGKEClient.createBackupPlanAsync(request).get();
 }

Parameter
Name	Description
`request`	`CreateBackupPlanRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<BackupPlan,OperationMetadata>`

createBackupPlanAsync(String parent, BackupPlan backupPlan, String backupPlanId)

public final OperationFuture<BackupPlan,OperationMetadata> createBackupPlanAsync(String parent, BackupPlan backupPlan, String backupPlanId)

Creates a new BackupPlan in a given location.

Sample code:


 // 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()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   BackupPlan backupPlan = BackupPlan.newBuilder().build();
   String backupPlanId = "backupPlanId-84871546";
   BackupPlan response =
       backupForGKEClient.createBackupPlanAsync(parent, backupPlan, backupPlanId).get();
 }

Parameters
Name	Description
`parent`	`String` Required. The location within which to create the BackupPlan. Format: `projects//locations/`
`backupPlan`	`BackupPlan` Required. The BackupPlan resource object to create.
`backupPlanId`	`String` Required. The client-provided short name for the BackupPlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupPlans in this location

Returns
Type	Description
`OperationFuture<BackupPlan,OperationMetadata>`

createBackupPlanCallable()

public final UnaryCallable<CreateBackupPlanRequest,Operation> createBackupPlanCallable()

Creates a new BackupPlan in a given location.

Sample code:


 // 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()) {
   CreateBackupPlanRequest request =
       CreateBackupPlanRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setBackupPlan(BackupPlan.newBuilder().build())
           .setBackupPlanId("backupPlanId-84871546")
           .build();
   ApiFuture<Operation> future =
       backupForGKEClient.createBackupPlanCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateBackupPlanRequest,Operation>`

createBackupPlanOperationCallable()

public final OperationCallable<CreateBackupPlanRequest,BackupPlan,OperationMetadata> createBackupPlanOperationCallable()

Creates a new BackupPlan in a given location.

Sample code:


 // 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()) {
   CreateBackupPlanRequest request =
       CreateBackupPlanRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setBackupPlan(BackupPlan.newBuilder().build())
           .setBackupPlanId("backupPlanId-84871546")
           .build();
   OperationFuture<BackupPlan, OperationMetadata> future =
       backupForGKEClient.createBackupPlanOperationCallable().futureCall(request);
   // Do something.
   BackupPlan response = future.get();
 }

Returns
Type	Description
`OperationCallable<CreateBackupPlanRequest,BackupPlan,OperationMetadata>`

createRestoreAsync(@Nullable RestorePlanName parent, Restore restore, String restoreId)

public final OperationFuture<Restore,OperationMetadata> createRestoreAsync(@Nullable RestorePlanName parent, Restore restore, String restoreId)

Creates a new Restore for the given RestorePlan.

Sample code:


 // 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()) {
   RestorePlanName parent = RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]");
   Restore restore = Restore.newBuilder().build();
   String restoreId = "restoreId-1845465015";
   Restore response = backupForGKEClient.createRestoreAsync(parent, restore, restoreId).get();
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.RestorePlanName` Required. The RestorePlan within which to create the Restore. Format: `projects//locations//restorePlans/*`
`restore`	`Restore` Required. The restore resource to create.
`restoreId`	`String` Required. The client-provided short name for the Restore resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Restores in this RestorePlan.

Returns
Type	Description
`OperationFuture<Restore,OperationMetadata>`

createRestoreAsync(CreateRestoreRequest request)

public final OperationFuture<Restore,OperationMetadata> createRestoreAsync(CreateRestoreRequest request)

Creates a new Restore for the given RestorePlan.

Sample code:


 // 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()) {
   CreateRestoreRequest request =
       CreateRestoreRequest.newBuilder()
           .setParent(RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]").toString())
           .setRestore(Restore.newBuilder().build())
           .setRestoreId("restoreId-1845465015")
           .build();
   Restore response = backupForGKEClient.createRestoreAsync(request).get();
 }

Parameter
Name	Description
`request`	`CreateRestoreRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Restore,OperationMetadata>`

createRestoreAsync(String parent, Restore restore, String restoreId)

public final OperationFuture<Restore,OperationMetadata> createRestoreAsync(String parent, Restore restore, String restoreId)

Creates a new Restore for the given RestorePlan.

Sample code:


 // 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()) {
   String parent = RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]").toString();
   Restore restore = Restore.newBuilder().build();
   String restoreId = "restoreId-1845465015";
   Restore response = backupForGKEClient.createRestoreAsync(parent, restore, restoreId).get();
 }

Parameters
Name	Description
`parent`	`String` Required. The RestorePlan within which to create the Restore. Format: `projects//locations//restorePlans/*`
`restore`	`Restore` Required. The restore resource to create.
`restoreId`	`String` Required. The client-provided short name for the Restore resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of Restores in this RestorePlan.

Returns
Type	Description
`OperationFuture<Restore,OperationMetadata>`

createRestoreCallable()

public final UnaryCallable<CreateRestoreRequest,Operation> createRestoreCallable()

Creates a new Restore for the given RestorePlan.

Sample code:


 // 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()) {
   CreateRestoreRequest request =
       CreateRestoreRequest.newBuilder()
           .setParent(RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]").toString())
           .setRestore(Restore.newBuilder().build())
           .setRestoreId("restoreId-1845465015")
           .build();
   ApiFuture<Operation> future = backupForGKEClient.createRestoreCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateRestoreRequest,Operation>`

createRestoreChannelAsync(@Nullable LocationName parent, RestoreChannel restoreChannel, String restoreChannelId)

public final OperationFuture<RestoreChannel,OperationMetadata> createRestoreChannelAsync(@Nullable LocationName parent, RestoreChannel restoreChannel, String restoreChannelId)

Creates a new RestoreChannel in a given location.

Sample code:


 // 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()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   RestoreChannel restoreChannel = RestoreChannel.newBuilder().build();
   String restoreChannelId = "restoreChannelId1139842704";
   RestoreChannel response =
       backupForGKEClient
           .createRestoreChannelAsync(parent, restoreChannel, restoreChannelId)
           .get();
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.LocationName` Required. The location within which to create the RestoreChannel. Format: `projects//locations/`
`restoreChannel`	`RestoreChannel` Required. The RestoreChannel resource object to create.
`restoreChannelId`	`String` Optional. The client-provided short name for the RestoreChannel resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of RestoreChannels in this location If the user does not provide a name, a uuid will be used as the name.

Returns
Type	Description
`OperationFuture<RestoreChannel,OperationMetadata>`

createRestoreChannelAsync(CreateRestoreChannelRequest request)

public final OperationFuture<RestoreChannel,OperationMetadata> createRestoreChannelAsync(CreateRestoreChannelRequest request)

Creates a new RestoreChannel in a given location.

Sample code:


 // 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()) {
   CreateRestoreChannelRequest request =
       CreateRestoreChannelRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRestoreChannel(RestoreChannel.newBuilder().build())
           .setRestoreChannelId("restoreChannelId1139842704")
           .build();
   RestoreChannel response = backupForGKEClient.createRestoreChannelAsync(request).get();
 }

Parameter
Name	Description
`request`	`CreateRestoreChannelRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<RestoreChannel,OperationMetadata>`

createRestoreChannelAsync(String parent, RestoreChannel restoreChannel, String restoreChannelId)

public final OperationFuture<RestoreChannel,OperationMetadata> createRestoreChannelAsync(String parent, RestoreChannel restoreChannel, String restoreChannelId)

Creates a new RestoreChannel in a given location.

Sample code:


 // 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()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   RestoreChannel restoreChannel = RestoreChannel.newBuilder().build();
   String restoreChannelId = "restoreChannelId1139842704";
   RestoreChannel response =
       backupForGKEClient
           .createRestoreChannelAsync(parent, restoreChannel, restoreChannelId)
           .get();
 }

Parameters
Name	Description
`parent`	`String` Required. The location within which to create the RestoreChannel. Format: `projects//locations/`
`restoreChannel`	`RestoreChannel` Required. The RestoreChannel resource object to create.
`restoreChannelId`	`String` Optional. The client-provided short name for the RestoreChannel resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of RestoreChannels in this location If the user does not provide a name, a uuid will be used as the name.

Returns
Type	Description
`OperationFuture<RestoreChannel,OperationMetadata>`

createRestoreChannelCallable()

public final UnaryCallable<CreateRestoreChannelRequest,Operation> createRestoreChannelCallable()

Creates a new RestoreChannel in a given location.

Sample code:


 // 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()) {
   CreateRestoreChannelRequest request =
       CreateRestoreChannelRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRestoreChannel(RestoreChannel.newBuilder().build())
           .setRestoreChannelId("restoreChannelId1139842704")
           .build();
   ApiFuture<Operation> future =
       backupForGKEClient.createRestoreChannelCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateRestoreChannelRequest,Operation>`

createRestoreChannelOperationCallable()

public final OperationCallable<CreateRestoreChannelRequest,RestoreChannel,OperationMetadata> createRestoreChannelOperationCallable()

Creates a new RestoreChannel in a given location.

Sample code:


 // 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()) {
   CreateRestoreChannelRequest request =
       CreateRestoreChannelRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRestoreChannel(RestoreChannel.newBuilder().build())
           .setRestoreChannelId("restoreChannelId1139842704")
           .build();
   OperationFuture<RestoreChannel, OperationMetadata> future =
       backupForGKEClient.createRestoreChannelOperationCallable().futureCall(request);
   // Do something.
   RestoreChannel response = future.get();
 }

Returns
Type	Description
`OperationCallable<CreateRestoreChannelRequest,RestoreChannel,OperationMetadata>`

createRestoreOperationCallable()

public final OperationCallable<CreateRestoreRequest,Restore,OperationMetadata> createRestoreOperationCallable()

Creates a new Restore for the given RestorePlan.

Sample code:


 // 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()) {
   CreateRestoreRequest request =
       CreateRestoreRequest.newBuilder()
           .setParent(RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]").toString())
           .setRestore(Restore.newBuilder().build())
           .setRestoreId("restoreId-1845465015")
           .build();
   OperationFuture<Restore, OperationMetadata> future =
       backupForGKEClient.createRestoreOperationCallable().futureCall(request);
   // Do something.
   Restore response = future.get();
 }

Returns
Type	Description
`OperationCallable<CreateRestoreRequest,Restore,OperationMetadata>`

createRestorePlanAsync(@Nullable LocationName parent, RestorePlan restorePlan, String restorePlanId)

public final OperationFuture<RestorePlan,OperationMetadata> createRestorePlanAsync(@Nullable LocationName parent, RestorePlan restorePlan, String restorePlanId)

Creates a new RestorePlan in a given location.

Sample code:


 // 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()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   RestorePlan restorePlan = RestorePlan.newBuilder().build();
   String restorePlanId = "restorePlanId-857896366";
   RestorePlan response =
       backupForGKEClient.createRestorePlanAsync(parent, restorePlan, restorePlanId).get();
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.LocationName` Required. The location within which to create the RestorePlan. Format: `projects//locations/`
`restorePlan`	`RestorePlan` Required. The RestorePlan resource object to create.
`restorePlanId`	`String` Required. The client-provided short name for the RestorePlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of RestorePlans in this location

Returns
Type	Description
`OperationFuture<RestorePlan,OperationMetadata>`

createRestorePlanAsync(CreateRestorePlanRequest request)

public final OperationFuture<RestorePlan,OperationMetadata> createRestorePlanAsync(CreateRestorePlanRequest request)

Creates a new RestorePlan in a given location.

Sample code:


 // 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()) {
   CreateRestorePlanRequest request =
       CreateRestorePlanRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRestorePlan(RestorePlan.newBuilder().build())
           .setRestorePlanId("restorePlanId-857896366")
           .build();
   RestorePlan response = backupForGKEClient.createRestorePlanAsync(request).get();
 }

Parameter
Name	Description
`request`	`CreateRestorePlanRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<RestorePlan,OperationMetadata>`

createRestorePlanAsync(String parent, RestorePlan restorePlan, String restorePlanId)

public final OperationFuture<RestorePlan,OperationMetadata> createRestorePlanAsync(String parent, RestorePlan restorePlan, String restorePlanId)

Creates a new RestorePlan in a given location.

Sample code:


 // 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()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   RestorePlan restorePlan = RestorePlan.newBuilder().build();
   String restorePlanId = "restorePlanId-857896366";
   RestorePlan response =
       backupForGKEClient.createRestorePlanAsync(parent, restorePlan, restorePlanId).get();
 }

Parameters
Name	Description
`parent`	`String` Required. The location within which to create the RestorePlan. Format: `projects//locations/`
`restorePlan`	`RestorePlan` Required. The RestorePlan resource object to create.
`restorePlanId`	`String` Required. The client-provided short name for the RestorePlan resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of RestorePlans in this location

Returns
Type	Description
`OperationFuture<RestorePlan,OperationMetadata>`

createRestorePlanCallable()

public final UnaryCallable<CreateRestorePlanRequest,Operation> createRestorePlanCallable()

Creates a new RestorePlan in a given location.

Sample code:


 // 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()) {
   CreateRestorePlanRequest request =
       CreateRestorePlanRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRestorePlan(RestorePlan.newBuilder().build())
           .setRestorePlanId("restorePlanId-857896366")
           .build();
   ApiFuture<Operation> future =
       backupForGKEClient.createRestorePlanCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateRestorePlanRequest,Operation>`

createRestorePlanOperationCallable()

public final OperationCallable<CreateRestorePlanRequest,RestorePlan,OperationMetadata> createRestorePlanOperationCallable()

Creates a new RestorePlan in a given location.

Sample code:


 // 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()) {
   CreateRestorePlanRequest request =
       CreateRestorePlanRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRestorePlan(RestorePlan.newBuilder().build())
           .setRestorePlanId("restorePlanId-857896366")
           .build();
   OperationFuture<RestorePlan, OperationMetadata> future =
       backupForGKEClient.createRestorePlanOperationCallable().futureCall(request);
   // Do something.
   RestorePlan response = future.get();
 }

Returns
Type	Description
`OperationCallable<CreateRestorePlanRequest,RestorePlan,OperationMetadata>`

deleteBackupAsync(@Nullable BackupName name)

public final OperationFuture<Empty,OperationMetadata> deleteBackupAsync(@Nullable BackupName name)

Deletes an existing Backup.

Sample code:


 // 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()) {
   BackupName name = BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]");
   backupForGKEClient.deleteBackupAsync(name).get();
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.BackupName` Required. Name of the Backup resource. Format: `projects//locations//backupPlans//backups/`

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteBackupAsync(DeleteBackupRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteBackupAsync(DeleteBackupRequest request)

Deletes an existing Backup.

Sample code:


 // 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()) {
   DeleteBackupRequest request =
       DeleteBackupRequest.newBuilder()
           .setName(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString())
           .setEtag("etag3123477")
           .setForce(true)
           .build();
   backupForGKEClient.deleteBackupAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteBackupRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteBackupAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteBackupAsync(String name)

Deletes an existing Backup.

Sample code:


 // 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()) {
   String name =
       BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString();
   backupForGKEClient.deleteBackupAsync(name).get();
 }

Parameter
Name	Description
`name`	`String` Required. Name of the Backup resource. Format: `projects//locations//backupPlans//backups/`

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteBackupCallable()

public final UnaryCallable<DeleteBackupRequest,Operation> deleteBackupCallable()

Deletes an existing Backup.

Sample code:


 // 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()) {
   DeleteBackupRequest request =
       DeleteBackupRequest.newBuilder()
           .setName(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString())
           .setEtag("etag3123477")
           .setForce(true)
           .build();
   ApiFuture<Operation> future = backupForGKEClient.deleteBackupCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteBackupRequest,Operation>`

deleteBackupChannelAsync(@Nullable BackupChannelName name)

public final OperationFuture<Empty,OperationMetadata> deleteBackupChannelAsync(@Nullable BackupChannelName name)

Deletes an existing BackupChannel.

Sample code:


 // 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()) {
   BackupChannelName name = BackupChannelName.of("[PROJECT]", "[LOCATION]", "[BACKUP_CHANNEL]");
   backupForGKEClient.deleteBackupChannelAsync(name).get();
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.BackupChannelName` Required. Fully qualified BackupChannel name. Format: `projects//locations//backupChannels/*`

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteBackupChannelAsync(DeleteBackupChannelRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteBackupChannelAsync(DeleteBackupChannelRequest request)

Deletes an existing BackupChannel.

Sample code:


 // 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()) {
   DeleteBackupChannelRequest request =
       DeleteBackupChannelRequest.newBuilder()
           .setName(
               BackupChannelName.of("[PROJECT]", "[LOCATION]", "[BACKUP_CHANNEL]").toString())
           .setEtag("etag3123477")
           .setForce(true)
           .build();
   backupForGKEClient.deleteBackupChannelAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteBackupChannelRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteBackupChannelAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteBackupChannelAsync(String name)

Deletes an existing BackupChannel.

Sample code:


 // 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()) {
   String name = BackupChannelName.of("[PROJECT]", "[LOCATION]", "[BACKUP_CHANNEL]").toString();
   backupForGKEClient.deleteBackupChannelAsync(name).get();
 }

Parameter
Name	Description
`name`	`String` Required. Fully qualified BackupChannel name. Format: `projects//locations//backupChannels/*`

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteBackupChannelCallable()

public final UnaryCallable<DeleteBackupChannelRequest,Operation> deleteBackupChannelCallable()

Deletes an existing BackupChannel.

Sample code:


 // 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()) {
   DeleteBackupChannelRequest request =
       DeleteBackupChannelRequest.newBuilder()
           .setName(
               BackupChannelName.of("[PROJECT]", "[LOCATION]", "[BACKUP_CHANNEL]").toString())
           .setEtag("etag3123477")
           .setForce(true)
           .build();
   ApiFuture<Operation> future =
       backupForGKEClient.deleteBackupChannelCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteBackupChannelRequest,Operation>`

deleteBackupChannelOperationCallable()

public final OperationCallable<DeleteBackupChannelRequest,Empty,OperationMetadata> deleteBackupChannelOperationCallable()

Deletes an existing BackupChannel.

Sample code:


 // 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()) {
   DeleteBackupChannelRequest request =
       DeleteBackupChannelRequest.newBuilder()
           .setName(
               BackupChannelName.of("[PROJECT]", "[LOCATION]", "[BACKUP_CHANNEL]").toString())
           .setEtag("etag3123477")
           .setForce(true)
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       backupForGKEClient.deleteBackupChannelOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteBackupChannelRequest,Empty,OperationMetadata>`

deleteBackupOperationCallable()

public final OperationCallable<DeleteBackupRequest,Empty,OperationMetadata> deleteBackupOperationCallable()

Deletes an existing Backup.

Sample code:


 // 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()) {
   DeleteBackupRequest request =
       DeleteBackupRequest.newBuilder()
           .setName(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString())
           .setEtag("etag3123477")
           .setForce(true)
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       backupForGKEClient.deleteBackupOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteBackupRequest,Empty,OperationMetadata>`

deleteBackupPlanAsync(@Nullable BackupPlanName name)

public final OperationFuture<Empty,OperationMetadata> deleteBackupPlanAsync(@Nullable BackupPlanName name)

Deletes an existing BackupPlan.

Sample code:


 // 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]");
   backupForGKEClient.deleteBackupPlanAsync(name).get();
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.BackupPlanName` Required. Fully qualified BackupPlan name. Format: `projects//locations//backupPlans/*`

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteBackupPlanAsync(DeleteBackupPlanRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteBackupPlanAsync(DeleteBackupPlanRequest request)

Deletes an existing BackupPlan.

Sample code:


 // 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()) {
   DeleteBackupPlanRequest request =
       DeleteBackupPlanRequest.newBuilder()
           .setName(BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]").toString())
           .setEtag("etag3123477")
           .build();
   backupForGKEClient.deleteBackupPlanAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteBackupPlanRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteBackupPlanAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteBackupPlanAsync(String name)

Deletes an existing BackupPlan.

Sample code:


 // 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()) {
   String name = BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]").toString();
   backupForGKEClient.deleteBackupPlanAsync(name).get();
 }

Parameter
Name	Description
`name`	`String` Required. Fully qualified BackupPlan name. Format: `projects//locations//backupPlans/*`

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteBackupPlanCallable()

public final UnaryCallable<DeleteBackupPlanRequest,Operation> deleteBackupPlanCallable()

Deletes an existing BackupPlan.

Sample code:


 // 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()) {
   DeleteBackupPlanRequest request =
       DeleteBackupPlanRequest.newBuilder()
           .setName(BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]").toString())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future =
       backupForGKEClient.deleteBackupPlanCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteBackupPlanRequest,Operation>`

deleteBackupPlanOperationCallable()

public final OperationCallable<DeleteBackupPlanRequest,Empty,OperationMetadata> deleteBackupPlanOperationCallable()

Deletes an existing BackupPlan.

Sample code:


 // 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()) {
   DeleteBackupPlanRequest request =
       DeleteBackupPlanRequest.newBuilder()
           .setName(BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]").toString())
           .setEtag("etag3123477")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       backupForGKEClient.deleteBackupPlanOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteBackupPlanRequest,Empty,OperationMetadata>`

deleteRestoreAsync(@Nullable RestoreName name)

public final OperationFuture<Empty,OperationMetadata> deleteRestoreAsync(@Nullable RestoreName name)

Deletes an existing Restore.

Sample code:


 // 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()) {
   RestoreName name = RestoreName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]");
   backupForGKEClient.deleteRestoreAsync(name).get();
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.RestoreName` Required. Full name of the Restore Format: `projects//locations//restorePlans//restores/`

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteRestoreAsync(DeleteRestoreRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteRestoreAsync(DeleteRestoreRequest request)

Deletes an existing Restore.

Sample code:


 // 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()) {
   DeleteRestoreRequest request =
       DeleteRestoreRequest.newBuilder()
           .setName(
               RestoreName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]")
                   .toString())
           .setEtag("etag3123477")
           .setForce(true)
           .build();
   backupForGKEClient.deleteRestoreAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteRestoreRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteRestoreAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteRestoreAsync(String name)

Deletes an existing Restore.

Sample code:


 // 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()) {
   String name =
       RestoreName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]").toString();
   backupForGKEClient.deleteRestoreAsync(name).get();
 }

Parameter
Name	Description
`name`	`String` Required. Full name of the Restore Format: `projects//locations//restorePlans//restores/`

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteRestoreCallable()

public final UnaryCallable<DeleteRestoreRequest,Operation> deleteRestoreCallable()

Deletes an existing Restore.

Sample code:


 // 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()) {
   DeleteRestoreRequest request =
       DeleteRestoreRequest.newBuilder()
           .setName(
               RestoreName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]")
                   .toString())
           .setEtag("etag3123477")
           .setForce(true)
           .build();
   ApiFuture<Operation> future = backupForGKEClient.deleteRestoreCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteRestoreRequest,Operation>`

deleteRestoreChannelAsync(@Nullable RestoreChannelName name)

public final OperationFuture<Empty,OperationMetadata> deleteRestoreChannelAsync(@Nullable RestoreChannelName name)

Deletes an existing RestoreChannel.

Sample code:


 // 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()) {
   RestoreChannelName name =
       RestoreChannelName.of("[PROJECT]", "[LOCATION]", "[RESTORE_CHANNEL]");
   backupForGKEClient.deleteRestoreChannelAsync(name).get();
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.RestoreChannelName` Required. Fully qualified RestoreChannel name. Format: `projects//locations//restoreChannels/*`

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteRestoreChannelAsync(DeleteRestoreChannelRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteRestoreChannelAsync(DeleteRestoreChannelRequest request)

Deletes an existing RestoreChannel.

Sample code:


 // 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()) {
   DeleteRestoreChannelRequest request =
       DeleteRestoreChannelRequest.newBuilder()
           .setName(
               RestoreChannelName.of("[PROJECT]", "[LOCATION]", "[RESTORE_CHANNEL]").toString())
           .setEtag("etag3123477")
           .build();
   backupForGKEClient.deleteRestoreChannelAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteRestoreChannelRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteRestoreChannelAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteRestoreChannelAsync(String name)

Deletes an existing RestoreChannel.

Sample code:


 // 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()) {
   String name =
       RestoreChannelName.of("[PROJECT]", "[LOCATION]", "[RESTORE_CHANNEL]").toString();
   backupForGKEClient.deleteRestoreChannelAsync(name).get();
 }

Parameter
Name	Description
`name`	`String` Required. Fully qualified RestoreChannel name. Format: `projects//locations//restoreChannels/*`

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteRestoreChannelCallable()

public final UnaryCallable<DeleteRestoreChannelRequest,Operation> deleteRestoreChannelCallable()

Deletes an existing RestoreChannel.

Sample code:


 // 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()) {
   DeleteRestoreChannelRequest request =
       DeleteRestoreChannelRequest.newBuilder()
           .setName(
               RestoreChannelName.of("[PROJECT]", "[LOCATION]", "[RESTORE_CHANNEL]").toString())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future =
       backupForGKEClient.deleteRestoreChannelCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteRestoreChannelRequest,Operation>`

deleteRestoreChannelOperationCallable()

public final OperationCallable<DeleteRestoreChannelRequest,Empty,OperationMetadata> deleteRestoreChannelOperationCallable()

Deletes an existing RestoreChannel.

Sample code:


 // 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()) {
   DeleteRestoreChannelRequest request =
       DeleteRestoreChannelRequest.newBuilder()
           .setName(
               RestoreChannelName.of("[PROJECT]", "[LOCATION]", "[RESTORE_CHANNEL]").toString())
           .setEtag("etag3123477")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       backupForGKEClient.deleteRestoreChannelOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteRestoreChannelRequest,Empty,OperationMetadata>`

deleteRestoreOperationCallable()

public final OperationCallable<DeleteRestoreRequest,Empty,OperationMetadata> deleteRestoreOperationCallable()

Deletes an existing Restore.

Sample code:


 // 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()) {
   DeleteRestoreRequest request =
       DeleteRestoreRequest.newBuilder()
           .setName(
               RestoreName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]")
                   .toString())
           .setEtag("etag3123477")
           .setForce(true)
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       backupForGKEClient.deleteRestoreOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteRestoreRequest,Empty,OperationMetadata>`

deleteRestorePlanAsync(@Nullable RestorePlanName name)

public final OperationFuture<Empty,OperationMetadata> deleteRestorePlanAsync(@Nullable RestorePlanName name)

Deletes an existing RestorePlan.

Sample code:


 // 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()) {
   RestorePlanName name = RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]");
   backupForGKEClient.deleteRestorePlanAsync(name).get();
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.RestorePlanName` Required. Fully qualified RestorePlan name. Format: `projects//locations//restorePlans/*`

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteRestorePlanAsync(DeleteRestorePlanRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteRestorePlanAsync(DeleteRestorePlanRequest request)

Deletes an existing RestorePlan.

Sample code:


 // 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()) {
   DeleteRestorePlanRequest request =
       DeleteRestorePlanRequest.newBuilder()
           .setName(RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]").toString())
           .setEtag("etag3123477")
           .setForce(true)
           .build();
   backupForGKEClient.deleteRestorePlanAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteRestorePlanRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteRestorePlanAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteRestorePlanAsync(String name)

Deletes an existing RestorePlan.

Sample code:


 // 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()) {
   String name = RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]").toString();
   backupForGKEClient.deleteRestorePlanAsync(name).get();
 }

Parameter
Name	Description
`name`	`String` Required. Fully qualified RestorePlan name. Format: `projects//locations//restorePlans/*`

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteRestorePlanCallable()

public final UnaryCallable<DeleteRestorePlanRequest,Operation> deleteRestorePlanCallable()

Deletes an existing RestorePlan.

Sample code:


 // 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()) {
   DeleteRestorePlanRequest request =
       DeleteRestorePlanRequest.newBuilder()
           .setName(RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]").toString())
           .setEtag("etag3123477")
           .setForce(true)
           .build();
   ApiFuture<Operation> future =
       backupForGKEClient.deleteRestorePlanCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteRestorePlanRequest,Operation>`

deleteRestorePlanOperationCallable()

public final OperationCallable<DeleteRestorePlanRequest,Empty,OperationMetadata> deleteRestorePlanOperationCallable()

Deletes an existing RestorePlan.

Sample code:


 // 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()) {
   DeleteRestorePlanRequest request =
       DeleteRestorePlanRequest.newBuilder()
           .setName(RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]").toString())
           .setEtag("etag3123477")
           .setForce(true)
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       backupForGKEClient.deleteRestorePlanOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteRestorePlanRequest,Empty,OperationMetadata>`

getBackup(@Nullable BackupName name)

public final Backup getBackup(@Nullable BackupName name)

Retrieve the details of a single Backup.

Sample code:


 // 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()) {
   BackupName name = BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]");
   Backup response = backupForGKEClient.getBackup(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.BackupName` Required. Full name of the Backup resource. Format: `projects//locations//backupPlans//backups/`

Returns
Type	Description
`Backup`

getBackup(GetBackupRequest request)

public final Backup getBackup(GetBackupRequest request)

Retrieve the details of a single Backup.

Sample code:


 // 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()) {
   GetBackupRequest request =
       GetBackupRequest.newBuilder()
           .setName(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString())
           .build();
   Backup response = backupForGKEClient.getBackup(request);
 }

Parameter
Name	Description
`request`	`GetBackupRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Backup`

getBackup(String name)

public final Backup getBackup(String name)

Retrieve the details of a single Backup.

Sample code:


 // 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()) {
   String name =
       BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString();
   Backup response = backupForGKEClient.getBackup(name);
 }

Parameter
Name	Description
`name`	`String` Required. Full name of the Backup resource. Format: `projects//locations//backupPlans//backups/`

Returns
Type	Description
`Backup`

getBackupCallable()

public final UnaryCallable<GetBackupRequest,Backup> getBackupCallable()

Retrieve the details of a single Backup.

Sample code:


 // 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()) {
   GetBackupRequest request =
       GetBackupRequest.newBuilder()
           .setName(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString())
           .build();
   ApiFuture<Backup> future = backupForGKEClient.getBackupCallable().futureCall(request);
   // Do something.
   Backup response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetBackupRequest,Backup>`

getBackupChannel(@Nullable BackupChannelName name)

public final BackupChannel getBackupChannel(@Nullable BackupChannelName name)

Retrieve the details of a single BackupChannel.

Sample code:


 // 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()) {
   BackupChannelName name = BackupChannelName.of("[PROJECT]", "[LOCATION]", "[BACKUP_CHANNEL]");
   BackupChannel response = backupForGKEClient.getBackupChannel(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.BackupChannelName` Required. Fully qualified BackupChannel name. Format: `projects//locations//backupChannels/*`

Returns
Type	Description
`BackupChannel`

getBackupChannel(GetBackupChannelRequest request)

public final BackupChannel getBackupChannel(GetBackupChannelRequest request)

Retrieve the details of a single BackupChannel.

Sample code:


 // 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()) {
   GetBackupChannelRequest request =
       GetBackupChannelRequest.newBuilder()
           .setName(
               BackupChannelName.of("[PROJECT]", "[LOCATION]", "[BACKUP_CHANNEL]").toString())
           .build();
   BackupChannel response = backupForGKEClient.getBackupChannel(request);
 }

Parameter
Name	Description
`request`	`GetBackupChannelRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BackupChannel`

getBackupChannel(String name)

public final BackupChannel getBackupChannel(String name)

Retrieve the details of a single BackupChannel.

Sample code:


 // 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()) {
   String name = BackupChannelName.of("[PROJECT]", "[LOCATION]", "[BACKUP_CHANNEL]").toString();
   BackupChannel response = backupForGKEClient.getBackupChannel(name);
 }

Parameter
Name	Description
`name`	`String` Required. Fully qualified BackupChannel name. Format: `projects//locations//backupChannels/*`

Returns
Type	Description
`BackupChannel`

getBackupChannelCallable()

public final UnaryCallable<GetBackupChannelRequest,BackupChannel> getBackupChannelCallable()

Retrieve the details of a single BackupChannel.

Sample code:


 // 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()) {
   GetBackupChannelRequest request =
       GetBackupChannelRequest.newBuilder()
           .setName(
               BackupChannelName.of("[PROJECT]", "[LOCATION]", "[BACKUP_CHANNEL]").toString())
           .build();
   ApiFuture<BackupChannel> future =
       backupForGKEClient.getBackupChannelCallable().futureCall(request);
   // Do something.
   BackupChannel response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetBackupChannelRequest,BackupChannel>`

getBackupIndexDownloadUrl(@Nullable BackupName backup)

public final GetBackupIndexDownloadUrlResponse getBackupIndexDownloadUrl(@Nullable BackupName backup)

Retrieve the link to the backupIndex.

Sample code:


 // 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()) {
   BackupName backup = BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]");
   GetBackupIndexDownloadUrlResponse response =
       backupForGKEClient.getBackupIndexDownloadUrl(backup);
 }

Parameter
Name	Description
`backup`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.BackupName` Required. Full name of Backup resource. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}

Returns
Type	Description
`GetBackupIndexDownloadUrlResponse`

getBackupIndexDownloadUrl(GetBackupIndexDownloadUrlRequest request)

public final GetBackupIndexDownloadUrlResponse getBackupIndexDownloadUrl(GetBackupIndexDownloadUrlRequest request)

Retrieve the link to the backupIndex.

Sample code:


 // 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()) {
   GetBackupIndexDownloadUrlRequest request =
       GetBackupIndexDownloadUrlRequest.newBuilder()
           .setBackup(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString())
           .build();
   GetBackupIndexDownloadUrlResponse response =
       backupForGKEClient.getBackupIndexDownloadUrl(request);
 }

Parameter
Name	Description
`request`	`GetBackupIndexDownloadUrlRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`GetBackupIndexDownloadUrlResponse`

getBackupIndexDownloadUrl(String backup)

public final GetBackupIndexDownloadUrlResponse getBackupIndexDownloadUrl(String backup)

Retrieve the link to the backupIndex.

Sample code:


 // 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()) {
   String backup =
       BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString();
   GetBackupIndexDownloadUrlResponse response =
       backupForGKEClient.getBackupIndexDownloadUrl(backup);
 }

Parameter
Name	Description
`backup`	`String` Required. Full name of Backup resource. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}

Returns
Type	Description
`GetBackupIndexDownloadUrlResponse`

getBackupIndexDownloadUrlCallable()

public final UnaryCallable<GetBackupIndexDownloadUrlRequest,GetBackupIndexDownloadUrlResponse> getBackupIndexDownloadUrlCallable()

Retrieve the link to the backupIndex.

Sample code:


 // 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()) {
   GetBackupIndexDownloadUrlRequest request =
       GetBackupIndexDownloadUrlRequest.newBuilder()
           .setBackup(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString())
           .build();
   ApiFuture<GetBackupIndexDownloadUrlResponse> future =
       backupForGKEClient.getBackupIndexDownloadUrlCallable().futureCall(request);
   // Do something.
   GetBackupIndexDownloadUrlResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetBackupIndexDownloadUrlRequest,GetBackupIndexDownloadUrlResponse>`

getBackupPlan(@Nullable BackupPlanName name)

public final BackupPlan getBackupPlan(@Nullable BackupPlanName name)

Retrieve the details of a single BackupPlan.

Sample code:


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

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.BackupPlanName` Required. Fully qualified BackupPlan name. Format: `projects//locations//backupPlans/*`

Returns
Type	Description
`BackupPlan`

getBackupPlan(GetBackupPlanRequest request)

public final BackupPlan getBackupPlan(GetBackupPlanRequest request)

Retrieve the details of a single BackupPlan.

Sample code:


 // 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()) {
   GetBackupPlanRequest request =
       GetBackupPlanRequest.newBuilder()
           .setName(BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]").toString())
           .build();
   BackupPlan response = backupForGKEClient.getBackupPlan(request);
 }

Parameter
Name	Description
`request`	`GetBackupPlanRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BackupPlan`

getBackupPlan(String name)

public final BackupPlan getBackupPlan(String name)

Retrieve the details of a single BackupPlan.

Sample code:


 // 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()) {
   String name = BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]").toString();
   BackupPlan response = backupForGKEClient.getBackupPlan(name);
 }

Parameter
Name	Description
`name`	`String` Required. Fully qualified BackupPlan name. Format: `projects//locations//backupPlans/*`

Returns
Type	Description
`BackupPlan`

getBackupPlanBinding(@Nullable BackupPlanBindingName name)

public final BackupPlanBinding getBackupPlanBinding(@Nullable BackupPlanBindingName name)

Retrieve the details of a single BackupPlanBinding.

Sample code:


 // 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()) {
   BackupPlanBindingName name =
       BackupPlanBindingName.of(
           "[PROJECT]", "[LOCATION]", "[BACKUP_CHANNEL]", "[BACKUP_PLAN_BINDING]");
   BackupPlanBinding response = backupForGKEClient.getBackupPlanBinding(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.BackupPlanBindingName` Required. Fully qualified BackupPlanBinding name. Format: `projects//locations//backupChannels//backupPlanBindings/`

Returns
Type	Description
`BackupPlanBinding`

getBackupPlanBinding(GetBackupPlanBindingRequest request)

public final BackupPlanBinding getBackupPlanBinding(GetBackupPlanBindingRequest request)

Retrieve the details of a single BackupPlanBinding.

Sample code:


 // 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()) {
   GetBackupPlanBindingRequest request =
       GetBackupPlanBindingRequest.newBuilder()
           .setName(
               BackupPlanBindingName.of(
                       "[PROJECT]", "[LOCATION]", "[BACKUP_CHANNEL]", "[BACKUP_PLAN_BINDING]")
                   .toString())
           .build();
   BackupPlanBinding response = backupForGKEClient.getBackupPlanBinding(request);
 }

Parameter
Name	Description
`request`	`GetBackupPlanBindingRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BackupPlanBinding`

getBackupPlanBinding(String name)

public final BackupPlanBinding getBackupPlanBinding(String name)

Retrieve the details of a single BackupPlanBinding.

Sample code:


 // 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()) {
   String name =
       BackupPlanBindingName.of(
               "[PROJECT]", "[LOCATION]", "[BACKUP_CHANNEL]", "[BACKUP_PLAN_BINDING]")
           .toString();
   BackupPlanBinding response = backupForGKEClient.getBackupPlanBinding(name);
 }

Parameter
Name	Description
`name`	`String` Required. Fully qualified BackupPlanBinding name. Format: `projects//locations//backupChannels//backupPlanBindings/`

Returns
Type	Description
`BackupPlanBinding`

getBackupPlanBindingCallable()

public final UnaryCallable<GetBackupPlanBindingRequest,BackupPlanBinding> getBackupPlanBindingCallable()

Retrieve the details of a single BackupPlanBinding.

Sample code:


 // 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()) {
   GetBackupPlanBindingRequest request =
       GetBackupPlanBindingRequest.newBuilder()
           .setName(
               BackupPlanBindingName.of(
                       "[PROJECT]", "[LOCATION]", "[BACKUP_CHANNEL]", "[BACKUP_PLAN_BINDING]")
                   .toString())
           .build();
   ApiFuture<BackupPlanBinding> future =
       backupForGKEClient.getBackupPlanBindingCallable().futureCall(request);
   // Do something.
   BackupPlanBinding response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetBackupPlanBindingRequest,BackupPlanBinding>`

getBackupPlanCallable()

public final UnaryCallable<GetBackupPlanRequest,BackupPlan> getBackupPlanCallable()

Retrieve the details of a single BackupPlan.

Sample code:


 // 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()) {
   GetBackupPlanRequest request =
       GetBackupPlanRequest.newBuilder()
           .setName(BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]").toString())
           .build();
   ApiFuture<BackupPlan> future = backupForGKEClient.getBackupPlanCallable().futureCall(request);
   // Do something.
   BackupPlan response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetBackupPlanRequest,BackupPlan>`

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
`OperationsClient`

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Sample code:


 // 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()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = backupForGKEClient.getIamPolicy(request);
 }

Parameter
Name	Description
`request`	`com.google.iam.v1.GetIamPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.iam.v1.Policy`

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Sample code:


 // 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()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = backupForGKEClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


 // 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()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = backupForGKEClient.getLocation(request);
 }

Parameter
Name	Description
`request`	`com.google.cloud.location.GetLocationRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.cloud.location.Location`

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // 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()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = backupForGKEClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
`OperationsClient`

getRestore(@Nullable RestoreName name)

public final Restore getRestore(@Nullable RestoreName name)

Retrieves the details of a single Restore.

Sample code:


 // 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()) {
   RestoreName name = RestoreName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]");
   Restore response = backupForGKEClient.getRestore(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.RestoreName` Required. Name of the restore resource. Format: `projects//locations//restorePlans//restores/`

Returns
Type	Description
`Restore`

getRestore(GetRestoreRequest request)

public final Restore getRestore(GetRestoreRequest request)

Retrieves the details of a single Restore.

Sample code:


 // 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()) {
   GetRestoreRequest request =
       GetRestoreRequest.newBuilder()
           .setName(
               RestoreName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]")
                   .toString())
           .build();
   Restore response = backupForGKEClient.getRestore(request);
 }

Parameter
Name	Description
`request`	`GetRestoreRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Restore`

getRestore(String name)

public final Restore getRestore(String name)

Retrieves the details of a single Restore.

Sample code:


 // 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()) {
   String name =
       RestoreName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]").toString();
   Restore response = backupForGKEClient.getRestore(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the restore resource. Format: `projects//locations//restorePlans//restores/`

Returns
Type	Description
`Restore`

getRestoreCallable()

public final UnaryCallable<GetRestoreRequest,Restore> getRestoreCallable()

Retrieves the details of a single Restore.

Sample code:


 // 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()) {
   GetRestoreRequest request =
       GetRestoreRequest.newBuilder()
           .setName(
               RestoreName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]")
                   .toString())
           .build();
   ApiFuture<Restore> future = backupForGKEClient.getRestoreCallable().futureCall(request);
   // Do something.
   Restore response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetRestoreRequest,Restore>`

getRestoreChannel(@Nullable RestoreChannelName name)

public final RestoreChannel getRestoreChannel(@Nullable RestoreChannelName name)

Retrieve the details of a single RestoreChannel.

Sample code:


 // 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()) {
   RestoreChannelName name =
       RestoreChannelName.of("[PROJECT]", "[LOCATION]", "[RESTORE_CHANNEL]");
   RestoreChannel response = backupForGKEClient.getRestoreChannel(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.RestoreChannelName` Required. Fully qualified RestoreChannel name. Format: `projects//locations//restoreChannels/*`

Returns
Type	Description
`RestoreChannel`

getRestoreChannel(GetRestoreChannelRequest request)

public final RestoreChannel getRestoreChannel(GetRestoreChannelRequest request)

Retrieve the details of a single RestoreChannel.

Sample code:


 // 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()) {
   GetRestoreChannelRequest request =
       GetRestoreChannelRequest.newBuilder()
           .setName(
               RestoreChannelName.of("[PROJECT]", "[LOCATION]", "[RESTORE_CHANNEL]").toString())
           .build();
   RestoreChannel response = backupForGKEClient.getRestoreChannel(request);
 }

Parameter
Name	Description
`request`	`GetRestoreChannelRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`RestoreChannel`

getRestoreChannel(String name)

public final RestoreChannel getRestoreChannel(String name)

Retrieve the details of a single RestoreChannel.

Sample code:


 // 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()) {
   String name =
       RestoreChannelName.of("[PROJECT]", "[LOCATION]", "[RESTORE_CHANNEL]").toString();
   RestoreChannel response = backupForGKEClient.getRestoreChannel(name);
 }

Parameter
Name	Description
`name`	`String` Required. Fully qualified RestoreChannel name. Format: `projects//locations//restoreChannels/*`

Returns
Type	Description
`RestoreChannel`

getRestoreChannelCallable()

public final UnaryCallable<GetRestoreChannelRequest,RestoreChannel> getRestoreChannelCallable()

Retrieve the details of a single RestoreChannel.

Sample code:


 // 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()) {
   GetRestoreChannelRequest request =
       GetRestoreChannelRequest.newBuilder()
           .setName(
               RestoreChannelName.of("[PROJECT]", "[LOCATION]", "[RESTORE_CHANNEL]").toString())
           .build();
   ApiFuture<RestoreChannel> future =
       backupForGKEClient.getRestoreChannelCallable().futureCall(request);
   // Do something.
   RestoreChannel response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetRestoreChannelRequest,RestoreChannel>`

getRestorePlan(@Nullable RestorePlanName name)

public final RestorePlan getRestorePlan(@Nullable RestorePlanName name)

Retrieve the details of a single RestorePlan.

Sample code:


 // 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()) {
   RestorePlanName name = RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]");
   RestorePlan response = backupForGKEClient.getRestorePlan(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.RestorePlanName` Required. Fully qualified RestorePlan name. Format: `projects//locations//restorePlans/*`

Returns
Type	Description
`RestorePlan`

getRestorePlan(GetRestorePlanRequest request)

public final RestorePlan getRestorePlan(GetRestorePlanRequest request)

Retrieve the details of a single RestorePlan.

Sample code:


 // 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()) {
   GetRestorePlanRequest request =
       GetRestorePlanRequest.newBuilder()
           .setName(RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]").toString())
           .build();
   RestorePlan response = backupForGKEClient.getRestorePlan(request);
 }

Parameter
Name	Description
`request`	`GetRestorePlanRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`RestorePlan`

getRestorePlan(String name)

public final RestorePlan getRestorePlan(String name)

Retrieve the details of a single RestorePlan.

Sample code:


 // 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()) {
   String name = RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]").toString();
   RestorePlan response = backupForGKEClient.getRestorePlan(name);
 }

Parameter
Name	Description
`name`	`String` Required. Fully qualified RestorePlan name. Format: `projects//locations//restorePlans/*`

Returns
Type	Description
`RestorePlan`

getRestorePlanBinding(@Nullable RestorePlanBindingName name)

public final RestorePlanBinding getRestorePlanBinding(@Nullable RestorePlanBindingName name)

Retrieve the details of a single RestorePlanBinding.

Sample code:


 // 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()) {
   RestorePlanBindingName name =
       RestorePlanBindingName.of(
           "[PROJECT]", "[LOCATION]", "[RESTORE_CHANNEL]", "[RESTORE_PLAN_BINDING]");
   RestorePlanBinding response = backupForGKEClient.getRestorePlanBinding(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.RestorePlanBindingName` Required. Fully qualified RestorePlanBinding name. Format: `projects//locations//restoreChannels//restorePlanBindings/`

Returns
Type	Description
`RestorePlanBinding`

getRestorePlanBinding(GetRestorePlanBindingRequest request)

public final RestorePlanBinding getRestorePlanBinding(GetRestorePlanBindingRequest request)

Retrieve the details of a single RestorePlanBinding.

Sample code:


 // 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()) {
   GetRestorePlanBindingRequest request =
       GetRestorePlanBindingRequest.newBuilder()
           .setName(
               RestorePlanBindingName.of(
                       "[PROJECT]", "[LOCATION]", "[RESTORE_CHANNEL]", "[RESTORE_PLAN_BINDING]")
                   .toString())
           .build();
   RestorePlanBinding response = backupForGKEClient.getRestorePlanBinding(request);
 }

Parameter
Name	Description
`request`	`GetRestorePlanBindingRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`RestorePlanBinding`

getRestorePlanBinding(String name)

public final RestorePlanBinding getRestorePlanBinding(String name)

Retrieve the details of a single RestorePlanBinding.

Sample code:


 // 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()) {
   String name =
       RestorePlanBindingName.of(
               "[PROJECT]", "[LOCATION]", "[RESTORE_CHANNEL]", "[RESTORE_PLAN_BINDING]")
           .toString();
   RestorePlanBinding response = backupForGKEClient.getRestorePlanBinding(name);
 }

Parameter
Name	Description
`name`	`String` Required. Fully qualified RestorePlanBinding name. Format: `projects//locations//restoreChannels//restorePlanBindings/`

Returns
Type	Description
`RestorePlanBinding`

getRestorePlanBindingCallable()

public final UnaryCallable<GetRestorePlanBindingRequest,RestorePlanBinding> getRestorePlanBindingCallable()

Retrieve the details of a single RestorePlanBinding.

Sample code:


 // 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()) {
   GetRestorePlanBindingRequest request =
       GetRestorePlanBindingRequest.newBuilder()
           .setName(
               RestorePlanBindingName.of(
                       "[PROJECT]", "[LOCATION]", "[RESTORE_CHANNEL]", "[RESTORE_PLAN_BINDING]")
                   .toString())
           .build();
   ApiFuture<RestorePlanBinding> future =
       backupForGKEClient.getRestorePlanBindingCallable().futureCall(request);
   // Do something.
   RestorePlanBinding response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetRestorePlanBindingRequest,RestorePlanBinding>`

getRestorePlanCallable()

public final UnaryCallable<GetRestorePlanRequest,RestorePlan> getRestorePlanCallable()

Retrieve the details of a single RestorePlan.

Sample code:


 // 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()) {
   GetRestorePlanRequest request =
       GetRestorePlanRequest.newBuilder()
           .setName(RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]").toString())
           .build();
   ApiFuture<RestorePlan> future =
       backupForGKEClient.getRestorePlanCallable().futureCall(request);
   // Do something.
   RestorePlan response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetRestorePlanRequest,RestorePlan>`

getSettings()

public final @Nullable BackupForGKESettings getSettings()

Returns
Type	Description
`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.BackupForGKESettings`

getStub()

public BackupForGKEStub getStub()

Returns
Type	Description
`BackupForGKEStub`

getVolumeBackup(@Nullable VolumeBackupName name)

public final VolumeBackup getVolumeBackup(@Nullable VolumeBackupName name)

Retrieve the details of a single VolumeBackup.

Sample code:


 // 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()) {
   VolumeBackupName name =
       VolumeBackupName.of(
           "[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]", "[VOLUME_BACKUP]");
   VolumeBackup response = backupForGKEClient.getVolumeBackup(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.VolumeBackupName` Required. Full name of the VolumeBackup resource. Format: `projects//locations//backupPlans//backups//volumeBackups/*`

Returns
Type	Description
`VolumeBackup`

getVolumeBackup(GetVolumeBackupRequest request)

public final VolumeBackup getVolumeBackup(GetVolumeBackupRequest request)

Retrieve the details of a single VolumeBackup.

Sample code:


 // 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()) {
   GetVolumeBackupRequest request =
       GetVolumeBackupRequest.newBuilder()
           .setName(
               VolumeBackupName.of(
                       "[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]", "[VOLUME_BACKUP]")
                   .toString())
           .build();
   VolumeBackup response = backupForGKEClient.getVolumeBackup(request);
 }

Parameter
Name	Description
`request`	`GetVolumeBackupRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`VolumeBackup`

getVolumeBackup(String name)

public final VolumeBackup getVolumeBackup(String name)

Retrieve the details of a single VolumeBackup.

Sample code:


 // 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()) {
   String name =
       VolumeBackupName.of(
               "[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]", "[VOLUME_BACKUP]")
           .toString();
   VolumeBackup response = backupForGKEClient.getVolumeBackup(name);
 }

Parameter
Name	Description
`name`	`String` Required. Full name of the VolumeBackup resource. Format: `projects//locations//backupPlans//backups//volumeBackups/*`

Returns
Type	Description
`VolumeBackup`

getVolumeBackupCallable()

public final UnaryCallable<GetVolumeBackupRequest,VolumeBackup> getVolumeBackupCallable()

Retrieve the details of a single VolumeBackup.

Sample code:


 // 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()) {
   GetVolumeBackupRequest request =
       GetVolumeBackupRequest.newBuilder()
           .setName(
               VolumeBackupName.of(
                       "[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]", "[VOLUME_BACKUP]")
                   .toString())
           .build();
   ApiFuture<VolumeBackup> future =
       backupForGKEClient.getVolumeBackupCallable().futureCall(request);
   // Do something.
   VolumeBackup response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetVolumeBackupRequest,VolumeBackup>`

getVolumeRestore(@Nullable VolumeRestoreName name)

public final VolumeRestore getVolumeRestore(@Nullable VolumeRestoreName name)

Retrieve the details of a single VolumeRestore.

Sample code:


 // 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()) {
   VolumeRestoreName name =
       VolumeRestoreName.of(
           "[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]", "[VOLUME_RESTORE]");
   VolumeRestore response = backupForGKEClient.getVolumeRestore(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.VolumeRestoreName` Required. Full name of the VolumeRestore resource. Format: `projects//locations//restorePlans//restores//volumeRestores/*`

Returns
Type	Description
`VolumeRestore`

getVolumeRestore(GetVolumeRestoreRequest request)

public final VolumeRestore getVolumeRestore(GetVolumeRestoreRequest request)

Retrieve the details of a single VolumeRestore.

Sample code:


 // 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()) {
   GetVolumeRestoreRequest request =
       GetVolumeRestoreRequest.newBuilder()
           .setName(
               VolumeRestoreName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[RESTORE_PLAN]",
                       "[RESTORE]",
                       "[VOLUME_RESTORE]")
                   .toString())
           .build();
   VolumeRestore response = backupForGKEClient.getVolumeRestore(request);
 }

Parameter
Name	Description
`request`	`GetVolumeRestoreRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`VolumeRestore`

getVolumeRestore(String name)

public final VolumeRestore getVolumeRestore(String name)

Retrieve the details of a single VolumeRestore.

Sample code:


 // 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()) {
   String name =
       VolumeRestoreName.of(
               "[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]", "[VOLUME_RESTORE]")
           .toString();
   VolumeRestore response = backupForGKEClient.getVolumeRestore(name);
 }

Parameter
Name	Description
`name`	`String` Required. Full name of the VolumeRestore resource. Format: `projects//locations//restorePlans//restores//volumeRestores/*`

Returns
Type	Description
`VolumeRestore`

getVolumeRestoreCallable()

public final UnaryCallable<GetVolumeRestoreRequest,VolumeRestore> getVolumeRestoreCallable()

Retrieve the details of a single VolumeRestore.

Sample code:


 // 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()) {
   GetVolumeRestoreRequest request =
       GetVolumeRestoreRequest.newBuilder()
           .setName(
               VolumeRestoreName.of(
                       "[PROJECT]",
                       "[LOCATION]",
                       "[RESTORE_PLAN]",
                       "[RESTORE]",
                       "[VOLUME_RESTORE]")
                   .toString())
           .build();
   ApiFuture<VolumeRestore> future =
       backupForGKEClient.getVolumeRestoreCallable().futureCall(request);
   // Do something.
   VolumeRestore response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetVolumeRestoreRequest,VolumeRestore>`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listBackupChannels(@Nullable LocationName parent)

public final BackupForGKEClient.ListBackupChannelsPagedResponse listBackupChannels(@Nullable LocationName parent)

Lists BackupChannels in a given location.

Sample code:


 // 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()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (BackupChannel element : backupForGKEClient.listBackupChannels(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.LocationName` Required. The location that contains the BackupChannels to list. Format: `projects//locations/`

Returns
Type	Description
`BackupForGKEClient.ListBackupChannelsPagedResponse`

listBackupChannels(ListBackupChannelsRequest request)

public final BackupForGKEClient.ListBackupChannelsPagedResponse listBackupChannels(ListBackupChannelsRequest request)

Lists BackupChannels in a given location.

Sample code:


 // 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()) {
   ListBackupChannelsRequest request =
       ListBackupChannelsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (BackupChannel element : backupForGKEClient.listBackupChannels(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListBackupChannelsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BackupForGKEClient.ListBackupChannelsPagedResponse`

listBackupChannels(String parent)

public final BackupForGKEClient.ListBackupChannelsPagedResponse listBackupChannels(String parent)

Lists BackupChannels in a given location.

Sample code:


 // 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()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (BackupChannel element : backupForGKEClient.listBackupChannels(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The location that contains the BackupChannels to list. Format: `projects//locations/`

Returns
Type	Description
`BackupForGKEClient.ListBackupChannelsPagedResponse`

listBackupChannelsCallable()

public final UnaryCallable<ListBackupChannelsRequest,ListBackupChannelsResponse> listBackupChannelsCallable()

Lists BackupChannels in a given location.

Sample code:


 // 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()) {
   ListBackupChannelsRequest request =
       ListBackupChannelsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListBackupChannelsResponse response =
         backupForGKEClient.listBackupChannelsCallable().call(request);
     for (BackupChannel element : response.getBackupChannelsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListBackupChannelsRequest,ListBackupChannelsResponse>`

listBackupChannelsPagedCallable()

public final UnaryCallable<ListBackupChannelsRequest,BackupForGKEClient.ListBackupChannelsPagedResponse> listBackupChannelsPagedCallable()

Lists BackupChannels in a given location.

Sample code:


 // 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()) {
   ListBackupChannelsRequest request =
       ListBackupChannelsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<BackupChannel> future =
       backupForGKEClient.listBackupChannelsPagedCallable().futureCall(request);
   // Do something.
   for (BackupChannel element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListBackupChannelsRequest,ListBackupChannelsPagedResponse>`

listBackupPlanBindings(@Nullable BackupChannelName parent)

public final BackupForGKEClient.ListBackupPlanBindingsPagedResponse listBackupPlanBindings(@Nullable BackupChannelName parent)

Lists BackupPlanBindings in a given location.

Sample code:


 // 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()) {
   BackupChannelName parent =
       BackupChannelName.of("[PROJECT]", "[LOCATION]", "[BACKUP_CHANNEL]");
   for (BackupPlanBinding element :
       backupForGKEClient.listBackupPlanBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.BackupChannelName` Required. The BackupChannel that contains the BackupPlanBindings to list. Format: `projects//locations//backupChannels/*`

Returns
Type	Description
`BackupForGKEClient.ListBackupPlanBindingsPagedResponse`

listBackupPlanBindings(ListBackupPlanBindingsRequest request)

public final BackupForGKEClient.ListBackupPlanBindingsPagedResponse listBackupPlanBindings(ListBackupPlanBindingsRequest request)

Lists BackupPlanBindings in a given location.

Sample code:


 // 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()) {
   ListBackupPlanBindingsRequest request =
       ListBackupPlanBindingsRequest.newBuilder()
           .setParent(
               BackupChannelName.of("[PROJECT]", "[LOCATION]", "[BACKUP_CHANNEL]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (BackupPlanBinding element :
       backupForGKEClient.listBackupPlanBindings(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListBackupPlanBindingsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BackupForGKEClient.ListBackupPlanBindingsPagedResponse`

listBackupPlanBindings(String parent)

public final BackupForGKEClient.ListBackupPlanBindingsPagedResponse listBackupPlanBindings(String parent)

Lists BackupPlanBindings in a given location.

Sample code:


 // 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()) {
   String parent =
       BackupChannelName.of("[PROJECT]", "[LOCATION]", "[BACKUP_CHANNEL]").toString();
   for (BackupPlanBinding element :
       backupForGKEClient.listBackupPlanBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The BackupChannel that contains the BackupPlanBindings to list. Format: `projects//locations//backupChannels/*`

Returns
Type	Description
`BackupForGKEClient.ListBackupPlanBindingsPagedResponse`

listBackupPlanBindingsCallable()

public final UnaryCallable<ListBackupPlanBindingsRequest,ListBackupPlanBindingsResponse> listBackupPlanBindingsCallable()

Lists BackupPlanBindings in a given location.

Sample code:


 // 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()) {
   ListBackupPlanBindingsRequest request =
       ListBackupPlanBindingsRequest.newBuilder()
           .setParent(
               BackupChannelName.of("[PROJECT]", "[LOCATION]", "[BACKUP_CHANNEL]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListBackupPlanBindingsResponse response =
         backupForGKEClient.listBackupPlanBindingsCallable().call(request);
     for (BackupPlanBinding element : response.getBackupPlanBindingsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListBackupPlanBindingsRequest,ListBackupPlanBindingsResponse>`

listBackupPlanBindingsPagedCallable()

public final UnaryCallable<ListBackupPlanBindingsRequest,BackupForGKEClient.ListBackupPlanBindingsPagedResponse> listBackupPlanBindingsPagedCallable()

Lists BackupPlanBindings in a given location.

Sample code:


 // 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()) {
   ListBackupPlanBindingsRequest request =
       ListBackupPlanBindingsRequest.newBuilder()
           .setParent(
               BackupChannelName.of("[PROJECT]", "[LOCATION]", "[BACKUP_CHANNEL]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<BackupPlanBinding> future =
       backupForGKEClient.listBackupPlanBindingsPagedCallable().futureCall(request);
   // Do something.
   for (BackupPlanBinding element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListBackupPlanBindingsRequest,ListBackupPlanBindingsPagedResponse>`

listBackupPlans(@Nullable LocationName parent)

public final BackupForGKEClient.ListBackupPlansPagedResponse listBackupPlans(@Nullable LocationName parent)

Lists BackupPlans in a given location.

Sample code:


 // 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()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (BackupPlan element : backupForGKEClient.listBackupPlans(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.LocationName` Required. The location that contains the BackupPlans to list. Format: `projects//locations/`

Returns
Type	Description
`BackupForGKEClient.ListBackupPlansPagedResponse`

listBackupPlans(ListBackupPlansRequest request)

public final BackupForGKEClient.ListBackupPlansPagedResponse listBackupPlans(ListBackupPlansRequest request)

Lists BackupPlans in a given location.

Sample code:


 // 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()) {
   ListBackupPlansRequest request =
       ListBackupPlansRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (BackupPlan element : backupForGKEClient.listBackupPlans(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListBackupPlansRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BackupForGKEClient.ListBackupPlansPagedResponse`

listBackupPlans(String parent)

public final BackupForGKEClient.ListBackupPlansPagedResponse listBackupPlans(String parent)

Lists BackupPlans in a given location.

Sample code:


 // 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()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (BackupPlan element : backupForGKEClient.listBackupPlans(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The location that contains the BackupPlans to list. Format: `projects//locations/`

Returns
Type	Description
`BackupForGKEClient.ListBackupPlansPagedResponse`

listBackupPlansCallable()

public final UnaryCallable<ListBackupPlansRequest,ListBackupPlansResponse> listBackupPlansCallable()

Lists BackupPlans in a given location.

Sample code:


 // 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()) {
   ListBackupPlansRequest request =
       ListBackupPlansRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListBackupPlansResponse response =
         backupForGKEClient.listBackupPlansCallable().call(request);
     for (BackupPlan element : response.getBackupPlansList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListBackupPlansRequest,ListBackupPlansResponse>`

listBackupPlansPagedCallable()

public final UnaryCallable<ListBackupPlansRequest,BackupForGKEClient.ListBackupPlansPagedResponse> listBackupPlansPagedCallable()

Lists BackupPlans in a given location.

Sample code:


 // 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()) {
   ListBackupPlansRequest request =
       ListBackupPlansRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<BackupPlan> future =
       backupForGKEClient.listBackupPlansPagedCallable().futureCall(request);
   // Do something.
   for (BackupPlan element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListBackupPlansRequest,ListBackupPlansPagedResponse>`

listBackups(@Nullable BackupPlanName parent)

public final BackupForGKEClient.ListBackupsPagedResponse listBackups(@Nullable BackupPlanName parent)

Lists the Backups for a given BackupPlan.

Sample code:


 // 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 parent = BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]");
   for (Backup element : backupForGKEClient.listBackups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.BackupPlanName` Required. The BackupPlan that contains the Backups to list. Format: `projects//locations//backupPlans/*`

Returns
Type	Description
`BackupForGKEClient.ListBackupsPagedResponse`

listBackups(ListBackupsRequest request)

public final BackupForGKEClient.ListBackupsPagedResponse listBackups(ListBackupsRequest request)

Lists the Backups for a given BackupPlan.

Sample code:


 // 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()) {
   ListBackupsRequest request =
       ListBackupsRequest.newBuilder()
           .setParent(BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setReturnPartialSuccess(true)
           .build();
   for (Backup element : backupForGKEClient.listBackups(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListBackupsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BackupForGKEClient.ListBackupsPagedResponse`

listBackups(String parent)

public final BackupForGKEClient.ListBackupsPagedResponse listBackups(String parent)

Lists the Backups for a given BackupPlan.

Sample code:


 // 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()) {
   String parent = BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]").toString();
   for (Backup element : backupForGKEClient.listBackups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The BackupPlan that contains the Backups to list. Format: `projects//locations//backupPlans/*`

Returns
Type	Description
`BackupForGKEClient.ListBackupsPagedResponse`

listBackupsCallable()

public final UnaryCallable<ListBackupsRequest,ListBackupsResponse> listBackupsCallable()

Lists the Backups for a given BackupPlan.

Sample code:


 // 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()) {
   ListBackupsRequest request =
       ListBackupsRequest.newBuilder()
           .setParent(BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     ListBackupsResponse response = backupForGKEClient.listBackupsCallable().call(request);
     for (Backup element : response.getBackupsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListBackupsRequest,ListBackupsResponse>`

listBackupsPagedCallable()

public final UnaryCallable<ListBackupsRequest,BackupForGKEClient.ListBackupsPagedResponse> listBackupsPagedCallable()

Lists the Backups for a given BackupPlan.

Sample code:


 // 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()) {
   ListBackupsRequest request =
       ListBackupsRequest.newBuilder()
           .setParent(BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Backup> future = backupForGKEClient.listBackupsPagedCallable().futureCall(request);
   // Do something.
   for (Backup element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListBackupsRequest,ListBackupsPagedResponse>`

listLocations(ListLocationsRequest request)

public final BackupForGKEClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:


 // 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()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : backupForGKEClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`com.google.cloud.location.ListLocationsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BackupForGKEClient.ListLocationsPagedResponse`

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // 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()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = backupForGKEClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,BackupForGKEClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:


 // 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()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       backupForGKEClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>`

listRestoreChannels(@Nullable LocationName parent)

public final BackupForGKEClient.ListRestoreChannelsPagedResponse listRestoreChannels(@Nullable LocationName parent)

Lists RestoreChannels in a given location.

Sample code:


 // 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()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (RestoreChannel element : backupForGKEClient.listRestoreChannels(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.LocationName` Required. The location that contains the RestoreChannels to list. Format: `projects//locations/`

Returns
Type	Description
`BackupForGKEClient.ListRestoreChannelsPagedResponse`

listRestoreChannels(ListRestoreChannelsRequest request)

public final BackupForGKEClient.ListRestoreChannelsPagedResponse listRestoreChannels(ListRestoreChannelsRequest request)

Lists RestoreChannels in a given location.

Sample code:


 // 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()) {
   ListRestoreChannelsRequest request =
       ListRestoreChannelsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (RestoreChannel element : backupForGKEClient.listRestoreChannels(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListRestoreChannelsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BackupForGKEClient.ListRestoreChannelsPagedResponse`

listRestoreChannels(String parent)

public final BackupForGKEClient.ListRestoreChannelsPagedResponse listRestoreChannels(String parent)

Lists RestoreChannels in a given location.

Sample code:


 // 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()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (RestoreChannel element : backupForGKEClient.listRestoreChannels(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The location that contains the RestoreChannels to list. Format: `projects//locations/`

Returns
Type	Description
`BackupForGKEClient.ListRestoreChannelsPagedResponse`

listRestoreChannelsCallable()

public final UnaryCallable<ListRestoreChannelsRequest,ListRestoreChannelsResponse> listRestoreChannelsCallable()

Lists RestoreChannels in a given location.

Sample code:


 // 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()) {
   ListRestoreChannelsRequest request =
       ListRestoreChannelsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListRestoreChannelsResponse response =
         backupForGKEClient.listRestoreChannelsCallable().call(request);
     for (RestoreChannel element : response.getRestoreChannelsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListRestoreChannelsRequest,ListRestoreChannelsResponse>`

listRestoreChannelsPagedCallable()

public final UnaryCallable<ListRestoreChannelsRequest,BackupForGKEClient.ListRestoreChannelsPagedResponse> listRestoreChannelsPagedCallable()

Lists RestoreChannels in a given location.

Sample code:


 // 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()) {
   ListRestoreChannelsRequest request =
       ListRestoreChannelsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<RestoreChannel> future =
       backupForGKEClient.listRestoreChannelsPagedCallable().futureCall(request);
   // Do something.
   for (RestoreChannel element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListRestoreChannelsRequest,ListRestoreChannelsPagedResponse>`

listRestorePlanBindings(@Nullable RestoreChannelName parent)

public final BackupForGKEClient.ListRestorePlanBindingsPagedResponse listRestorePlanBindings(@Nullable RestoreChannelName parent)

Lists RestorePlanBindings in a given location.

Sample code:


 // 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()) {
   RestoreChannelName parent =
       RestoreChannelName.of("[PROJECT]", "[LOCATION]", "[RESTORE_CHANNEL]");
   for (RestorePlanBinding element :
       backupForGKEClient.listRestorePlanBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.RestoreChannelName` Required. The RestoreChannel that contains the ListRestorePlanBindings to list. Format: `projects//locations//restoreChannels/*`

Returns
Type	Description
`BackupForGKEClient.ListRestorePlanBindingsPagedResponse`

listRestorePlanBindings(ListRestorePlanBindingsRequest request)

public final BackupForGKEClient.ListRestorePlanBindingsPagedResponse listRestorePlanBindings(ListRestorePlanBindingsRequest request)

Lists RestorePlanBindings in a given location.

Sample code:


 // 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()) {
   ListRestorePlanBindingsRequest request =
       ListRestorePlanBindingsRequest.newBuilder()
           .setParent(
               RestoreChannelName.of("[PROJECT]", "[LOCATION]", "[RESTORE_CHANNEL]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (RestorePlanBinding element :
       backupForGKEClient.listRestorePlanBindings(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListRestorePlanBindingsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BackupForGKEClient.ListRestorePlanBindingsPagedResponse`

listRestorePlanBindings(String parent)

public final BackupForGKEClient.ListRestorePlanBindingsPagedResponse listRestorePlanBindings(String parent)

Lists RestorePlanBindings in a given location.

Sample code:


 // 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()) {
   String parent =
       RestoreChannelName.of("[PROJECT]", "[LOCATION]", "[RESTORE_CHANNEL]").toString();
   for (RestorePlanBinding element :
       backupForGKEClient.listRestorePlanBindings(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The RestoreChannel that contains the ListRestorePlanBindings to list. Format: `projects//locations//restoreChannels/*`

Returns
Type	Description
`BackupForGKEClient.ListRestorePlanBindingsPagedResponse`

listRestorePlanBindingsCallable()

public final UnaryCallable<ListRestorePlanBindingsRequest,ListRestorePlanBindingsResponse> listRestorePlanBindingsCallable()

Lists RestorePlanBindings in a given location.

Sample code:


 // 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()) {
   ListRestorePlanBindingsRequest request =
       ListRestorePlanBindingsRequest.newBuilder()
           .setParent(
               RestoreChannelName.of("[PROJECT]", "[LOCATION]", "[RESTORE_CHANNEL]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListRestorePlanBindingsResponse response =
         backupForGKEClient.listRestorePlanBindingsCallable().call(request);
     for (RestorePlanBinding element : response.getRestorePlanBindingsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListRestorePlanBindingsRequest,ListRestorePlanBindingsResponse>`

listRestorePlanBindingsPagedCallable()

public final UnaryCallable<ListRestorePlanBindingsRequest,BackupForGKEClient.ListRestorePlanBindingsPagedResponse> listRestorePlanBindingsPagedCallable()

Lists RestorePlanBindings in a given location.

Sample code:


 // 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()) {
   ListRestorePlanBindingsRequest request =
       ListRestorePlanBindingsRequest.newBuilder()
           .setParent(
               RestoreChannelName.of("[PROJECT]", "[LOCATION]", "[RESTORE_CHANNEL]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<RestorePlanBinding> future =
       backupForGKEClient.listRestorePlanBindingsPagedCallable().futureCall(request);
   // Do something.
   for (RestorePlanBinding element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListRestorePlanBindingsRequest,ListRestorePlanBindingsPagedResponse>`

listRestorePlans(@Nullable LocationName parent)

public final BackupForGKEClient.ListRestorePlansPagedResponse listRestorePlans(@Nullable LocationName parent)

Lists RestorePlans in a given location.

Sample code:


 // 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()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (RestorePlan element : backupForGKEClient.listRestorePlans(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.LocationName` Required. The location that contains the RestorePlans to list. Format: `projects//locations/`

Returns
Type	Description
`BackupForGKEClient.ListRestorePlansPagedResponse`

listRestorePlans(ListRestorePlansRequest request)

public final BackupForGKEClient.ListRestorePlansPagedResponse listRestorePlans(ListRestorePlansRequest request)

Lists RestorePlans in a given location.

Sample code:


 // 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()) {
   ListRestorePlansRequest request =
       ListRestorePlansRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (RestorePlan element : backupForGKEClient.listRestorePlans(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListRestorePlansRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BackupForGKEClient.ListRestorePlansPagedResponse`

listRestorePlans(String parent)

public final BackupForGKEClient.ListRestorePlansPagedResponse listRestorePlans(String parent)

Lists RestorePlans in a given location.

Sample code:


 // 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()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (RestorePlan element : backupForGKEClient.listRestorePlans(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The location that contains the RestorePlans to list. Format: `projects//locations/`

Returns
Type	Description
`BackupForGKEClient.ListRestorePlansPagedResponse`

listRestorePlansCallable()

public final UnaryCallable<ListRestorePlansRequest,ListRestorePlansResponse> listRestorePlansCallable()

Lists RestorePlans in a given location.

Sample code:


 // 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()) {
   ListRestorePlansRequest request =
       ListRestorePlansRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListRestorePlansResponse response =
         backupForGKEClient.listRestorePlansCallable().call(request);
     for (RestorePlan element : response.getRestorePlansList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListRestorePlansRequest,ListRestorePlansResponse>`

listRestorePlansPagedCallable()

public final UnaryCallable<ListRestorePlansRequest,BackupForGKEClient.ListRestorePlansPagedResponse> listRestorePlansPagedCallable()

Lists RestorePlans in a given location.

Sample code:


 // 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()) {
   ListRestorePlansRequest request =
       ListRestorePlansRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<RestorePlan> future =
       backupForGKEClient.listRestorePlansPagedCallable().futureCall(request);
   // Do something.
   for (RestorePlan element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListRestorePlansRequest,ListRestorePlansPagedResponse>`

listRestores(@Nullable RestorePlanName parent)

public final BackupForGKEClient.ListRestoresPagedResponse listRestores(@Nullable RestorePlanName parent)

Lists the Restores for a given RestorePlan.

Sample code:


 // 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()) {
   RestorePlanName parent = RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]");
   for (Restore element : backupForGKEClient.listRestores(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.RestorePlanName` Required. The RestorePlan that contains the Restores to list. Format: `projects//locations//restorePlans/*`

Returns
Type	Description
`BackupForGKEClient.ListRestoresPagedResponse`

listRestores(ListRestoresRequest request)

public final BackupForGKEClient.ListRestoresPagedResponse listRestores(ListRestoresRequest request)

Lists the Restores for a given RestorePlan.

Sample code:


 // 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()) {
   ListRestoresRequest request =
       ListRestoresRequest.newBuilder()
           .setParent(RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Restore element : backupForGKEClient.listRestores(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListRestoresRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BackupForGKEClient.ListRestoresPagedResponse`

listRestores(String parent)

public final BackupForGKEClient.ListRestoresPagedResponse listRestores(String parent)

Lists the Restores for a given RestorePlan.

Sample code:


 // 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()) {
   String parent = RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]").toString();
   for (Restore element : backupForGKEClient.listRestores(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The RestorePlan that contains the Restores to list. Format: `projects//locations//restorePlans/*`

Returns
Type	Description
`BackupForGKEClient.ListRestoresPagedResponse`

listRestoresCallable()

public final UnaryCallable<ListRestoresRequest,ListRestoresResponse> listRestoresCallable()

Lists the Restores for a given RestorePlan.

Sample code:


 // 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()) {
   ListRestoresRequest request =
       ListRestoresRequest.newBuilder()
           .setParent(RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListRestoresResponse response = backupForGKEClient.listRestoresCallable().call(request);
     for (Restore element : response.getRestoresList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListRestoresRequest,ListRestoresResponse>`

listRestoresPagedCallable()

public final UnaryCallable<ListRestoresRequest,BackupForGKEClient.ListRestoresPagedResponse> listRestoresPagedCallable()

Lists the Restores for a given RestorePlan.

Sample code:


 // 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()) {
   ListRestoresRequest request =
       ListRestoresRequest.newBuilder()
           .setParent(RestorePlanName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Restore> future =
       backupForGKEClient.listRestoresPagedCallable().futureCall(request);
   // Do something.
   for (Restore element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListRestoresRequest,ListRestoresPagedResponse>`

listVolumeBackups(@Nullable BackupName parent)

public final BackupForGKEClient.ListVolumeBackupsPagedResponse listVolumeBackups(@Nullable BackupName parent)

Lists the VolumeBackups for a given Backup.

Sample code:


 // 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()) {
   BackupName parent = BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]");
   for (VolumeBackup element : backupForGKEClient.listVolumeBackups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.BackupName` Required. The Backup that contains the VolumeBackups to list. Format: `projects//locations//backupPlans//backups/`

Returns
Type	Description
`BackupForGKEClient.ListVolumeBackupsPagedResponse`

listVolumeBackups(ListVolumeBackupsRequest request)

public final BackupForGKEClient.ListVolumeBackupsPagedResponse listVolumeBackups(ListVolumeBackupsRequest request)

Lists the VolumeBackups for a given Backup.

Sample code:


 // 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()) {
   ListVolumeBackupsRequest request =
       ListVolumeBackupsRequest.newBuilder()
           .setParent(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (VolumeBackup element : backupForGKEClient.listVolumeBackups(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListVolumeBackupsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BackupForGKEClient.ListVolumeBackupsPagedResponse`

listVolumeBackups(String parent)

public final BackupForGKEClient.ListVolumeBackupsPagedResponse listVolumeBackups(String parent)

Lists the VolumeBackups for a given Backup.

Sample code:


 // 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()) {
   String parent =
       BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString();
   for (VolumeBackup element : backupForGKEClient.listVolumeBackups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The Backup that contains the VolumeBackups to list. Format: `projects//locations//backupPlans//backups/`

Returns
Type	Description
`BackupForGKEClient.ListVolumeBackupsPagedResponse`

listVolumeBackupsCallable()

public final UnaryCallable<ListVolumeBackupsRequest,ListVolumeBackupsResponse> listVolumeBackupsCallable()

Lists the VolumeBackups for a given Backup.

Sample code:


 // 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()) {
   ListVolumeBackupsRequest request =
       ListVolumeBackupsRequest.newBuilder()
           .setParent(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListVolumeBackupsResponse response =
         backupForGKEClient.listVolumeBackupsCallable().call(request);
     for (VolumeBackup element : response.getVolumeBackupsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListVolumeBackupsRequest,ListVolumeBackupsResponse>`

listVolumeBackupsPagedCallable()

public final UnaryCallable<ListVolumeBackupsRequest,BackupForGKEClient.ListVolumeBackupsPagedResponse> listVolumeBackupsPagedCallable()

Lists the VolumeBackups for a given Backup.

Sample code:


 // 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()) {
   ListVolumeBackupsRequest request =
       ListVolumeBackupsRequest.newBuilder()
           .setParent(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<VolumeBackup> future =
       backupForGKEClient.listVolumeBackupsPagedCallable().futureCall(request);
   // Do something.
   for (VolumeBackup element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListVolumeBackupsRequest,ListVolumeBackupsPagedResponse>`

listVolumeRestores(@Nullable RestoreName parent)

public final BackupForGKEClient.ListVolumeRestoresPagedResponse listVolumeRestores(@Nullable RestoreName parent)

Lists the VolumeRestores for a given Restore.

Sample code:


 // 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()) {
   RestoreName parent = RestoreName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]");
   for (VolumeRestore element : backupForGKEClient.listVolumeRestores(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.gkebackup.v1.RestoreName` Required. The Restore that contains the VolumeRestores to list. Format: `projects//locations//restorePlans//restores/`

Returns
Type	Description
`BackupForGKEClient.ListVolumeRestoresPagedResponse`

listVolumeRestores(ListVolumeRestoresRequest request)

public final BackupForGKEClient.ListVolumeRestoresPagedResponse listVolumeRestores(ListVolumeRestoresRequest request)

Lists the VolumeRestores for a given Restore.

Sample code:


 // 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()) {
   ListVolumeRestoresRequest request =
       ListVolumeRestoresRequest.newBuilder()
           .setParent(
               RestoreName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (VolumeRestore element : backupForGKEClient.listVolumeRestores(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListVolumeRestoresRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BackupForGKEClient.ListVolumeRestoresPagedResponse`

listVolumeRestores(String parent)

public final BackupForGKEClient.ListVolumeRestoresPagedResponse listVolumeRestores(String parent)

Lists the VolumeRestores for a given Restore.

Sample code:


 // 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()) {
   String parent =
       RestoreName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]").toString();
   for (VolumeRestore element : backupForGKEClient.listVolumeRestores(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The Restore that contains the VolumeRestores to list. Format: `projects//locations//restorePlans//restores/`

Returns
Type	Description
`BackupForGKEClient.ListVolumeRestoresPagedResponse`

listVolumeRestoresCallable()

public final UnaryCallable<ListVolumeRestoresRequest,ListVolumeRestoresResponse> listVolumeRestoresCallable()

Lists the VolumeRestores for a given Restore.

Sample code:


 // 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()) {
   ListVolumeRestoresRequest request =
       ListVolumeRestoresRequest.newBuilder()
           .setParent(
               RestoreName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListVolumeRestoresResponse response =
         backupForGKEClient.listVolumeRestoresCallable().call(request);
     for (VolumeRestore element : response.getVolumeRestoresList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListVolumeRestoresRequest,ListVolumeRestoresResponse>`

listVolumeRestoresPagedCallable()

public final UnaryCallable<ListVolumeRestoresRequest,BackupForGKEClient.ListVolumeRestoresPagedResponse> listVolumeRestoresPagedCallable()

Lists the VolumeRestores for a given Restore.

Sample code:


 // 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()) {
   ListVolumeRestoresRequest request =
       ListVolumeRestoresRequest.newBuilder()
           .setParent(
               RestoreName.of("[PROJECT]", "[LOCATION]", "[RESTORE_PLAN]", "[RESTORE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<VolumeRestore> future =
       backupForGKEClient.listVolumeRestoresPagedCallable().futureCall(request);
   // Do something.
   for (VolumeRestore element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListVolumeRestoresRequest,ListVolumeRestoresPagedResponse>`

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:


 // 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()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = backupForGKEClient.setIamPolicy(request);
 }

Parameter
Name	Description
`request`	`com.google.iam.v1.SetIamPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.iam.v1.Policy`

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:


 // 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()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = backupForGKEClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Sample code:


 // 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()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = backupForGKEClient.testIamPermissions(request);
 }

Parameter
Name	Description
`request`	`com.google.iam.v1.TestIamPermissionsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.iam.v1.TestIamPermissionsResponse`

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Sample code:


 // 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()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               BackupName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]", "[BACKUP]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       backupForGKEClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`

updateBackupAsync(Backup backup, FieldMask updateMask)

public final OperationFuture<Backup,OperationMetadata> updateBackupAsync(Backup backup, FieldMask updateMask)

Update a Backup.

Sample code:


 // 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()) {
   Backup backup = Backup.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Backup response = backupForGKEClient.updateBackupAsync(backup, updateMask).get();
 }

Parameters
Name	Description
`backup`	`Backup` Required. A new version of the Backup resource that contains updated fields. This may be sparsely populated if an `update_mask` is provided.
`updateMask`	`FieldMask` Optional. This is used to specify the fields to be overwritten in the Backup targeted for update. The values for each of these updated fields will be taken from the `backup_plan` provided with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `backup` will be written to the target Backup resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup` are ignored and are not used to update the target Backup.

Returns
Type	Description
`OperationFuture<Backup,OperationMetadata>`

updateBackupAsync(UpdateBackupRequest request)

public final OperationFuture<Backup,OperationMetadata> updateBackupAsync(UpdateBackupRequest request)

Update a Backup.

Sample code:


 // 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()) {
   UpdateBackupRequest request =
       UpdateBackupRequest.newBuilder()
           .setBackup(Backup.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Backup response = backupForGKEClient.updateBackupAsync(request).get();
 }

Parameter
Name	Description
`request`	`UpdateBackupRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Backup,OperationMetadata>`

updateBackupCallable()

public final UnaryCallable<UpdateBackupRequest,Operation> updateBackupCallable()

Update a Backup.

Sample code:


 // 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()) {
   UpdateBackupRequest request =
       UpdateBackupRequest.newBuilder()
           .setBackup(Backup.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future = backupForGKEClient.updateBackupCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateBackupRequest,Operation>`

updateBackupChannelAsync(BackupChannel backupChannel, FieldMask updateMask)

public final OperationFuture<BackupChannel,OperationMetadata> updateBackupChannelAsync(BackupChannel backupChannel, FieldMask updateMask)

Update a BackupChannel.

Sample code:


 // 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()) {
   BackupChannel backupChannel = BackupChannel.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   BackupChannel response =
       backupForGKEClient.updateBackupChannelAsync(backupChannel, updateMask).get();
 }

Parameters
Name	Description
`backupChannel`	`BackupChannel` Required. A new version of the BackupChannel resource that contains updated fields. This may be sparsely populated if an `update_mask` is provided.
`updateMask`	`FieldMask` Optional. This is used to specify the fields to be overwritten in the BackupChannel targeted for update. The values for each of these updated fields will be taken from the `backup_channel` provided with this request. Field names are relative to the root of the resource (e.g., `description`, `labels`, etc.) If no `update_mask` is provided, all fields in `backup_channel` will be written to the target BackupChannel resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup_channel` are ignored and are not used to update the target BackupChannel.

Returns
Type	Description
`OperationFuture<BackupChannel,OperationMetadata>`

updateBackupChannelAsync(UpdateBackupChannelRequest request)

public final OperationFuture<BackupChannel,OperationMetadata> updateBackupChannelAsync(UpdateBackupChannelRequest request)

Update a BackupChannel.

Sample code:


 // 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()) {
   UpdateBackupChannelRequest request =
       UpdateBackupChannelRequest.newBuilder()
           .setBackupChannel(BackupChannel.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   BackupChannel response = backupForGKEClient.updateBackupChannelAsync(request).get();
 }

Parameter
Name	Description
`request`	`UpdateBackupChannelRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<BackupChannel,OperationMetadata>`

updateBackupChannelCallable()

public final UnaryCallable<UpdateBackupChannelRequest,Operation> updateBackupChannelCallable()

Update a BackupChannel.

Sample code:


 // 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()) {
   UpdateBackupChannelRequest request =
       UpdateBackupChannelRequest.newBuilder()
           .setBackupChannel(BackupChannel.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       backupForGKEClient.updateBackupChannelCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateBackupChannelRequest,Operation>`

updateBackupChannelOperationCallable()

public final OperationCallable<UpdateBackupChannelRequest,BackupChannel,OperationMetadata> updateBackupChannelOperationCallable()

Update a BackupChannel.

Sample code:


 // 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()) {
   UpdateBackupChannelRequest request =
       UpdateBackupChannelRequest.newBuilder()
           .setBackupChannel(BackupChannel.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<BackupChannel, OperationMetadata> future =
       backupForGKEClient.updateBackupChannelOperationCallable().futureCall(request);
   // Do something.
   BackupChannel response = future.get();
 }

Returns
Type	Description
`OperationCallable<UpdateBackupChannelRequest,BackupChannel,OperationMetadata>`

updateBackupOperationCallable()

public final OperationCallable<UpdateBackupRequest,Backup,OperationMetadata> updateBackupOperationCallable()

Update a Backup.

Sample code:


 // 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()) {
   UpdateBackupRequest request =
       UpdateBackupRequest.newBuilder()
           .setBackup(Backup.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<Backup, OperationMetadata> future =
       backupForGKEClient.updateBackupOperationCallable().futureCall(request);
   // Do something.
   Backup response = future.get();
 }

Returns
Type	Description
`OperationCallable<UpdateBackupRequest,Backup,OperationMetadata>`

updateBackupPlanAsync(BackupPlan backupPlan, FieldMask updateMask)

public final OperationFuture<BackupPlan,OperationMetadata> updateBackupPlanAsync(BackupPlan backupPlan, FieldMask updateMask)

Update a BackupPlan.

Sample code:


 // 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()) {
   BackupPlan backupPlan = BackupPlan.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   BackupPlan response = backupForGKEClient.updateBackupPlanAsync(backupPlan, updateMask).get();
 }

Parameters
Name	Description
`backupPlan`	`BackupPlan` Required. A new version of the BackupPlan resource that contains updated fields. This may be sparsely populated if an `update_mask` is provided.
`updateMask`	`FieldMask` Optional. This is used to specify the fields to be overwritten in the BackupPlan targeted for update. The values for each of these updated fields will be taken from the `backup_plan` provided with this request. Field names are relative to the root of the resource (e.g., `description`, `backup_config.include_volume_data`, etc.) If no `update_mask` is provided, all fields in `backup_plan` will be written to the target BackupPlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup_plan` are ignored and are not used to update the target BackupPlan.

Returns
Type	Description
`OperationFuture<BackupPlan,OperationMetadata>`

updateBackupPlanAsync(UpdateBackupPlanRequest request)

public final OperationFuture<BackupPlan,OperationMetadata> updateBackupPlanAsync(UpdateBackupPlanRequest request)

Update a BackupPlan.

Sample code:


 // 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()) {
   UpdateBackupPlanRequest request =
       UpdateBackupPlanRequest.newBuilder()
           .setBackupPlan(BackupPlan.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   BackupPlan response = backupForGKEClient.updateBackupPlanAsync(request).get();
 }

Parameter
Name	Description
`request`	`UpdateBackupPlanRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<BackupPlan,OperationMetadata>`

updateBackupPlanCallable()

public final UnaryCallable<UpdateBackupPlanRequest,Operation> updateBackupPlanCallable()

Update a BackupPlan.

Sample code:


 // 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()) {
   UpdateBackupPlanRequest request =
       UpdateBackupPlanRequest.newBuilder()
           .setBackupPlan(BackupPlan.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       backupForGKEClient.updateBackupPlanCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateBackupPlanRequest,Operation>`

updateBackupPlanOperationCallable()

public final OperationCallable<UpdateBackupPlanRequest,BackupPlan,OperationMetadata> updateBackupPlanOperationCallable()

Update a BackupPlan.

Sample code:


 // 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()) {
   UpdateBackupPlanRequest request =
       UpdateBackupPlanRequest.newBuilder()
           .setBackupPlan(BackupPlan.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<BackupPlan, OperationMetadata> future =
       backupForGKEClient.updateBackupPlanOperationCallable().futureCall(request);
   // Do something.
   BackupPlan response = future.get();
 }

Returns
Type	Description
`OperationCallable<UpdateBackupPlanRequest,BackupPlan,OperationMetadata>`

updateRestoreAsync(Restore restore, FieldMask updateMask)

public final OperationFuture<Restore,OperationMetadata> updateRestoreAsync(Restore restore, FieldMask updateMask)

Update a Restore.

Sample code:


 // 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()) {
   Restore restore = Restore.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Restore response = backupForGKEClient.updateRestoreAsync(restore, updateMask).get();
 }

Parameters
Name	Description
`restore`	`Restore` Required. A new version of the Restore resource that contains updated fields. This may be sparsely populated if an `update_mask` is provided.
`updateMask`	`FieldMask` Optional. This is used to specify the fields to be overwritten in the Restore targeted for update. The values for each of these updated fields will be taken from the `restore` provided with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `restore` will be written to the target Restore resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `restore` are ignored and are not used to update the target Restore.

Returns
Type	Description
`OperationFuture<Restore,OperationMetadata>`

updateRestoreAsync(UpdateRestoreRequest request)

public final OperationFuture<Restore,OperationMetadata> updateRestoreAsync(UpdateRestoreRequest request)

Update a Restore.

Sample code:


 // 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()) {
   UpdateRestoreRequest request =
       UpdateRestoreRequest.newBuilder()
           .setRestore(Restore.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Restore response = backupForGKEClient.updateRestoreAsync(request).get();
 }

Parameter
Name	Description
`request`	`UpdateRestoreRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Restore,OperationMetadata>`

updateRestoreCallable()

public final UnaryCallable<UpdateRestoreRequest,Operation> updateRestoreCallable()

Update a Restore.

Sample code:


 // 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()) {
   UpdateRestoreRequest request =
       UpdateRestoreRequest.newBuilder()
           .setRestore(Restore.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future = backupForGKEClient.updateRestoreCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateRestoreRequest,Operation>`

updateRestoreChannelAsync(RestoreChannel restoreChannel, FieldMask updateMask)

public final OperationFuture<RestoreChannel,OperationMetadata> updateRestoreChannelAsync(RestoreChannel restoreChannel, FieldMask updateMask)

Update a RestoreChannel.

Sample code:


 // 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()) {
   RestoreChannel restoreChannel = RestoreChannel.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   RestoreChannel response =
       backupForGKEClient.updateRestoreChannelAsync(restoreChannel, updateMask).get();
 }

Parameters
Name	Description
`restoreChannel`	`RestoreChannel` Required. A new version of the RestoreChannel resource that contains updated fields. This may be sparsely populated if an `update_mask` is provided.
`updateMask`	`FieldMask` Optional. This is used to specify the fields to be overwritten in the RestoreChannel targeted for update. The values for each of these updated fields will be taken from the `restore_channel` provided with this request. Field names are relative to the root of the resource (e.g., `description`, `destination_project_id`, etc.) If no `update_mask` is provided, all fields in `restore_channel` will be written to the target RestoreChannel resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `restore_channel` are ignored and are not used to update the target RestoreChannel.

Returns
Type	Description
`OperationFuture<RestoreChannel,OperationMetadata>`

updateRestoreChannelAsync(UpdateRestoreChannelRequest request)

public final OperationFuture<RestoreChannel,OperationMetadata> updateRestoreChannelAsync(UpdateRestoreChannelRequest request)

Update a RestoreChannel.

Sample code:


 // 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()) {
   UpdateRestoreChannelRequest request =
       UpdateRestoreChannelRequest.newBuilder()
           .setRestoreChannel(RestoreChannel.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   RestoreChannel response = backupForGKEClient.updateRestoreChannelAsync(request).get();
 }

Parameter
Name	Description
`request`	`UpdateRestoreChannelRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<RestoreChannel,OperationMetadata>`

updateRestoreChannelCallable()

public final UnaryCallable<UpdateRestoreChannelRequest,Operation> updateRestoreChannelCallable()

Update a RestoreChannel.

Sample code:


 // 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()) {
   UpdateRestoreChannelRequest request =
       UpdateRestoreChannelRequest.newBuilder()
           .setRestoreChannel(RestoreChannel.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       backupForGKEClient.updateRestoreChannelCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateRestoreChannelRequest,Operation>`

updateRestoreChannelOperationCallable()

public final OperationCallable<UpdateRestoreChannelRequest,RestoreChannel,OperationMetadata> updateRestoreChannelOperationCallable()

Update a RestoreChannel.

Sample code:


 // 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()) {
   UpdateRestoreChannelRequest request =
       UpdateRestoreChannelRequest.newBuilder()
           .setRestoreChannel(RestoreChannel.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<RestoreChannel, OperationMetadata> future =
       backupForGKEClient.updateRestoreChannelOperationCallable().futureCall(request);
   // Do something.
   RestoreChannel response = future.get();
 }

Returns
Type	Description
`OperationCallable<UpdateRestoreChannelRequest,RestoreChannel,OperationMetadata>`

updateRestoreOperationCallable()

public final OperationCallable<UpdateRestoreRequest,Restore,OperationMetadata> updateRestoreOperationCallable()

Update a Restore.

Sample code:


 // 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()) {
   UpdateRestoreRequest request =
       UpdateRestoreRequest.newBuilder()
           .setRestore(Restore.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<Restore, OperationMetadata> future =
       backupForGKEClient.updateRestoreOperationCallable().futureCall(request);
   // Do something.
   Restore response = future.get();
 }

Returns
Type	Description
`OperationCallable<UpdateRestoreRequest,Restore,OperationMetadata>`

updateRestorePlanAsync(RestorePlan restorePlan, FieldMask updateMask)

public final OperationFuture<RestorePlan,OperationMetadata> updateRestorePlanAsync(RestorePlan restorePlan, FieldMask updateMask)

Update a RestorePlan.

Sample code:


 // 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()) {
   RestorePlan restorePlan = RestorePlan.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   RestorePlan response =
       backupForGKEClient.updateRestorePlanAsync(restorePlan, updateMask).get();
 }

Parameters
Name	Description
`restorePlan`	`RestorePlan` Required. A new version of the RestorePlan resource that contains updated fields. This may be sparsely populated if an `update_mask` is provided.
`updateMask`	`FieldMask` Optional. This is used to specify the fields to be overwritten in the RestorePlan targeted for update. The values for each of these updated fields will be taken from the `restore_plan` provided with this request. Field names are relative to the root of the resource. If no `update_mask` is provided, all fields in `restore_plan` will be written to the target RestorePlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `restore_plan` are ignored and are not used to update the target RestorePlan.

Returns
Type	Description
`OperationFuture<RestorePlan,OperationMetadata>`

updateRestorePlanAsync(UpdateRestorePlanRequest request)

public final OperationFuture<RestorePlan,OperationMetadata> updateRestorePlanAsync(UpdateRestorePlanRequest request)

Update a RestorePlan.

Sample code:


 // 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()) {
   UpdateRestorePlanRequest request =
       UpdateRestorePlanRequest.newBuilder()
           .setRestorePlan(RestorePlan.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   RestorePlan response = backupForGKEClient.updateRestorePlanAsync(request).get();
 }

Parameter
Name	Description
`request`	`UpdateRestorePlanRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<RestorePlan,OperationMetadata>`

updateRestorePlanCallable()

public final UnaryCallable<UpdateRestorePlanRequest,Operation> updateRestorePlanCallable()

Update a RestorePlan.

Sample code:


 // 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()) {
   UpdateRestorePlanRequest request =
       UpdateRestorePlanRequest.newBuilder()
           .setRestorePlan(RestorePlan.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       backupForGKEClient.updateRestorePlanCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateRestorePlanRequest,Operation>`

updateRestorePlanOperationCallable()

public final OperationCallable<UpdateRestorePlanRequest,RestorePlan,OperationMetadata> updateRestorePlanOperationCallable()

Update a RestorePlan.

Sample code:


 // 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()) {
   UpdateRestorePlanRequest request =
       UpdateRestorePlanRequest.newBuilder()
           .setRestorePlan(RestorePlan.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<RestorePlan, OperationMetadata> future =
       backupForGKEClient.updateRestorePlanOperationCallable().futureCall(request);
   // Do something.
   RestorePlan response = future.get();
 }

Returns
Type	Description
`OperationCallable<UpdateRestorePlanRequest,RestorePlan,OperationMetadata>`

Class BackupForGKEClient (0.94.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(BackupForGKESettings settings)

create(BackupForGKEStub stub)

Constructors

BackupForGKEClient(BackupForGKESettings settings)

BackupForGKEClient(BackupForGKEStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

createBackupAsync(@Nullable BackupPlanName parent, Backup backup, String backupId)

createBackupAsync(CreateBackupRequest request)

createBackupAsync(String parent, Backup backup, String backupId)

createBackupCallable()

createBackupChannelAsync(@Nullable LocationName parent, BackupChannel backupChannel, String backupChannelId)

createBackupChannelAsync(CreateBackupChannelRequest request)

createBackupChannelAsync(String parent, BackupChannel backupChannel, String backupChannelId)

createBackupChannelCallable()

createBackupChannelOperationCallable()

createBackupOperationCallable()

createBackupPlanAsync(@Nullable LocationName parent, BackupPlan backupPlan, String backupPlanId)

createBackupPlanAsync(CreateBackupPlanRequest request)

createBackupPlanAsync(String parent, BackupPlan backupPlan, String backupPlanId)

createBackupPlanCallable()

createBackupPlanOperationCallable()

createRestoreAsync(@Nullable RestorePlanName parent, Restore restore, String restoreId)

createRestoreAsync(CreateRestoreRequest request)

createRestoreAsync(String parent, Restore restore, String restoreId)

createRestoreCallable()

createRestoreChannelAsync(@Nullable LocationName parent, RestoreChannel restoreChannel, String restoreChannelId)

createRestoreChannelAsync(CreateRestoreChannelRequest request)

createRestoreChannelAsync(String parent, RestoreChannel restoreChannel, String restoreChannelId)

createRestoreChannelCallable()

createRestoreChannelOperationCallable()

createRestoreOperationCallable()

createRestorePlanAsync(@Nullable LocationName parent, RestorePlan restorePlan, String restorePlanId)

createRestorePlanAsync(CreateRestorePlanRequest request)

createRestorePlanAsync(String parent, RestorePlan restorePlan, String restorePlanId)

createRestorePlanCallable()

createRestorePlanOperationCallable()

deleteBackupAsync(@Nullable BackupName name)

deleteBackupAsync(DeleteBackupRequest request)

deleteBackupAsync(String name)

deleteBackupCallable()

deleteBackupChannelAsync(@Nullable BackupChannelName name)

deleteBackupChannelAsync(DeleteBackupChannelRequest request)

deleteBackupChannelAsync(String name)

deleteBackupChannelCallable()

deleteBackupChannelOperationCallable()

deleteBackupOperationCallable()

deleteBackupPlanAsync(@Nullable BackupPlanName name)

deleteBackupPlanAsync(DeleteBackupPlanRequest request)

deleteBackupPlanAsync(String name)

deleteBackupPlanCallable()

deleteBackupPlanOperationCallable()

deleteRestoreAsync(@Nullable RestoreName name)

deleteRestoreAsync(DeleteRestoreRequest request)

deleteRestoreAsync(String name)

deleteRestoreCallable()

deleteRestoreChannelAsync(@Nullable RestoreChannelName name)

deleteRestoreChannelAsync(DeleteRestoreChannelRequest request)

deleteRestoreChannelAsync(String name)

deleteRestoreChannelCallable()

deleteRestoreChannelOperationCallable()

deleteRestoreOperationCallable()

deleteRestorePlanAsync(@Nullable RestorePlanName name)

deleteRestorePlanAsync(DeleteRestorePlanRequest request)

deleteRestorePlanAsync(String name)

deleteRestorePlanCallable()

deleteRestorePlanOperationCallable()

getBackup(@Nullable BackupName name)

getBackup(GetBackupRequest request)

getBackup(String name)

getBackupCallable()

getBackupChannel(@Nullable BackupChannelName name)

getBackupChannel(GetBackupChannelRequest request)

getBackupChannel(String name)

getBackupChannelCallable()

Class BackupForGKEClient (0.94.0)