Class BackupForGKEClient
- java.lang.Object
-
- com.google.cloud.gkebackup.v1.BackupForGKEClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class BackupForGKEClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: BackupForGKE allows Kubernetes administrators to configure, execute, and manage backup and restore operations for their GKE clusters.This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (BackupForGKEClient backupForGKEClient = BackupForGKEClient.create()) { BackupPlanName name = BackupPlanName.of("[PROJECT]", "[LOCATION]", "[BACKUP_PLAN]"); BackupPlan response = backupForGKEClient.getBackupPlan(name); }
Note: close() needs to be called on the BackupForGKEClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of BackupForGKESettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library BackupForGKESettings backupForGKESettings = BackupForGKESettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); BackupForGKEClient backupForGKEClient = BackupForGKEClient.create(backupForGKESettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library BackupForGKESettings backupForGKESettings = BackupForGKESettings.newBuilder().setEndpoint(myEndpoint).build(); BackupForGKEClient backupForGKEClient = BackupForGKEClient.create(backupForGKESettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library BackupForGKESettings backupForGKESettings = BackupForGKESettings.newHttpJsonBuilder().build(); BackupForGKEClient backupForGKEClient = BackupForGKEClient.create(backupForGKESettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Nested Class Summary
-
Constructor Summary
Constructors Modifier Constructor Description protected
BackupForGKEClient(BackupForGKESettings settings)
Constructs an instance of BackupForGKEClient, using the given settings.protected
BackupForGKEClient(BackupForGKEStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static BackupForGKEClient
create()
Constructs an instance of BackupForGKEClient with default settings.static BackupForGKEClient
create(BackupForGKESettings settings)
Constructs an instance of BackupForGKEClient, using the given settings.static BackupForGKEClient
create(BackupForGKEStub stub)
Constructs an instance of BackupForGKEClient, using the given stub for making calls.com.google.api.gax.longrunning.OperationFuture<Backup,OperationMetadata>
createBackupAsync(BackupPlanName parent, Backup backup, String backupId)
Creates a Backup for the given BackupPlan.com.google.api.gax.longrunning.OperationFuture<Backup,OperationMetadata>
createBackupAsync(CreateBackupRequest request)
Creates a Backup for the given BackupPlan.com.google.api.gax.longrunning.OperationFuture<Backup,OperationMetadata>
createBackupAsync(String parent, Backup backup, String backupId)
Creates a Backup for the given BackupPlan.com.google.api.gax.rpc.UnaryCallable<CreateBackupRequest,com.google.longrunning.Operation>
createBackupCallable()
Creates a Backup for the given BackupPlan.com.google.api.gax.rpc.OperationCallable<CreateBackupRequest,Backup,OperationMetadata>
createBackupOperationCallable()
Creates a Backup for the given BackupPlan.com.google.api.gax.longrunning.OperationFuture<BackupPlan,OperationMetadata>
createBackupPlanAsync(CreateBackupPlanRequest request)
Creates a new BackupPlan in a given location.com.google.api.gax.longrunning.OperationFuture<BackupPlan,OperationMetadata>
createBackupPlanAsync(LocationName parent, BackupPlan backupPlan, String backupPlanId)
Creates a new BackupPlan in a given location.com.google.api.gax.longrunning.OperationFuture<BackupPlan,OperationMetadata>
createBackupPlanAsync(String parent, BackupPlan backupPlan, String backupPlanId)
Creates a new BackupPlan in a given location.com.google.api.gax.rpc.UnaryCallable<CreateBackupPlanRequest,com.google.longrunning.Operation>
createBackupPlanCallable()
Creates a new BackupPlan in a given location.com.google.api.gax.rpc.OperationCallable<CreateBackupPlanRequest,BackupPlan,OperationMetadata>
createBackupPlanOperationCallable()
Creates a new BackupPlan in a given location.com.google.api.gax.longrunning.OperationFuture<Restore,OperationMetadata>
createRestoreAsync(CreateRestoreRequest request)
Creates a new Restore for the given RestorePlan.com.google.api.gax.longrunning.OperationFuture<Restore,OperationMetadata>
createRestoreAsync(RestorePlanName parent, Restore restore, String restoreId)
Creates a new Restore for the given RestorePlan.com.google.api.gax.longrunning.OperationFuture<Restore,OperationMetadata>
createRestoreAsync(String parent, Restore restore, String restoreId)
Creates a new Restore for the given RestorePlan.com.google.api.gax.rpc.UnaryCallable<CreateRestoreRequest,com.google.longrunning.Operation>
createRestoreCallable()
Creates a new Restore for the given RestorePlan.com.google.api.gax.rpc.OperationCallable<CreateRestoreRequest,Restore,OperationMetadata>
createRestoreOperationCallable()
Creates a new Restore for the given RestorePlan.com.google.api.gax.longrunning.OperationFuture<RestorePlan,OperationMetadata>
createRestorePlanAsync(CreateRestorePlanRequest request)
Creates a new RestorePlan in a given location.com.google.api.gax.longrunning.OperationFuture<RestorePlan,OperationMetadata>
createRestorePlanAsync(LocationName parent, RestorePlan restorePlan, String restorePlanId)
Creates a new RestorePlan in a given location.com.google.api.gax.longrunning.OperationFuture<RestorePlan,OperationMetadata>
createRestorePlanAsync(String parent, RestorePlan restorePlan, String restorePlanId)
Creates a new RestorePlan in a given location.com.google.api.gax.rpc.UnaryCallable<CreateRestorePlanRequest,com.google.longrunning.Operation>
createRestorePlanCallable()
Creates a new RestorePlan in a given location.com.google.api.gax.rpc.OperationCallable<CreateRestorePlanRequest,RestorePlan,OperationMetadata>
createRestorePlanOperationCallable()
Creates a new RestorePlan in a given location.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteBackupAsync(BackupName name)
Deletes an existing Backup.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteBackupAsync(DeleteBackupRequest request)
Deletes an existing Backup.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteBackupAsync(String name)
Deletes an existing Backup.com.google.api.gax.rpc.UnaryCallable<DeleteBackupRequest,com.google.longrunning.Operation>
deleteBackupCallable()
Deletes an existing Backup.com.google.api.gax.rpc.OperationCallable<DeleteBackupRequest,com.google.protobuf.Empty,OperationMetadata>
deleteBackupOperationCallable()
Deletes an existing Backup.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteBackupPlanAsync(BackupPlanName name)
Deletes an existing BackupPlan.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteBackupPlanAsync(DeleteBackupPlanRequest request)
Deletes an existing BackupPlan.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteBackupPlanAsync(String name)
Deletes an existing BackupPlan.com.google.api.gax.rpc.UnaryCallable<DeleteBackupPlanRequest,com.google.longrunning.Operation>
deleteBackupPlanCallable()
Deletes an existing BackupPlan.com.google.api.gax.rpc.OperationCallable<DeleteBackupPlanRequest,com.google.protobuf.Empty,OperationMetadata>
deleteBackupPlanOperationCallable()
Deletes an existing BackupPlan.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteRestoreAsync(DeleteRestoreRequest request)
Deletes an existing Restore.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteRestoreAsync(RestoreName name)
Deletes an existing Restore.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteRestoreAsync(String name)
Deletes an existing Restore.com.google.api.gax.rpc.UnaryCallable<DeleteRestoreRequest,com.google.longrunning.Operation>
deleteRestoreCallable()
Deletes an existing Restore.com.google.api.gax.rpc.OperationCallable<DeleteRestoreRequest,com.google.protobuf.Empty,OperationMetadata>
deleteRestoreOperationCallable()
Deletes an existing Restore.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteRestorePlanAsync(DeleteRestorePlanRequest request)
Deletes an existing RestorePlan.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteRestorePlanAsync(RestorePlanName name)
Deletes an existing RestorePlan.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteRestorePlanAsync(String name)
Deletes an existing RestorePlan.com.google.api.gax.rpc.UnaryCallable<DeleteRestorePlanRequest,com.google.longrunning.Operation>
deleteRestorePlanCallable()
Deletes an existing RestorePlan.com.google.api.gax.rpc.OperationCallable<DeleteRestorePlanRequest,com.google.protobuf.Empty,OperationMetadata>
deleteRestorePlanOperationCallable()
Deletes an existing RestorePlan.Backup
getBackup(BackupName name)
Retrieve the details of a single Backup.Backup
getBackup(GetBackupRequest request)
Retrieve the details of a single Backup.Backup
getBackup(String name)
Retrieve the details of a single Backup.com.google.api.gax.rpc.UnaryCallable<GetBackupRequest,Backup>
getBackupCallable()
Retrieve the details of a single Backup.BackupPlan
getBackupPlan(BackupPlanName name)
Retrieve the details of a single BackupPlan.BackupPlan
getBackupPlan(GetBackupPlanRequest request)
Retrieve the details of a single BackupPlan.BackupPlan
getBackupPlan(String name)
Retrieve the details of a single BackupPlan.com.google.api.gax.rpc.UnaryCallable<GetBackupPlanRequest,BackupPlan>
getBackupPlanCallable()
Retrieve the details of a single BackupPlan.com.google.api.gax.httpjson.longrunning.OperationsClient
getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.com.google.iam.v1.Policy
getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
Gets the access control policy for a resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>
getIamPolicyCallable()
Gets the access control policy for a resource.com.google.cloud.location.Location
getLocation(com.google.cloud.location.GetLocationRequest request)
Gets information about a location.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>
getLocationCallable()
Gets information about a location.com.google.longrunning.OperationsClient
getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.Restore
getRestore(GetRestoreRequest request)
Retrieves the details of a single Restore.Restore
getRestore(RestoreName name)
Retrieves the details of a single Restore.Restore
getRestore(String name)
Retrieves the details of a single Restore.com.google.api.gax.rpc.UnaryCallable<GetRestoreRequest,Restore>
getRestoreCallable()
Retrieves the details of a single Restore.RestorePlan
getRestorePlan(GetRestorePlanRequest request)
Retrieve the details of a single RestorePlan.RestorePlan
getRestorePlan(RestorePlanName name)
Retrieve the details of a single RestorePlan.RestorePlan
getRestorePlan(String name)
Retrieve the details of a single RestorePlan.com.google.api.gax.rpc.UnaryCallable<GetRestorePlanRequest,RestorePlan>
getRestorePlanCallable()
Retrieve the details of a single RestorePlan.BackupForGKESettings
getSettings()
BackupForGKEStub
getStub()
VolumeBackup
getVolumeBackup(GetVolumeBackupRequest request)
Retrieve the details of a single VolumeBackup.VolumeBackup
getVolumeBackup(VolumeBackupName name)
Retrieve the details of a single VolumeBackup.VolumeBackup
getVolumeBackup(String name)
Retrieve the details of a single VolumeBackup.com.google.api.gax.rpc.UnaryCallable<GetVolumeBackupRequest,VolumeBackup>
getVolumeBackupCallable()
Retrieve the details of a single VolumeBackup.VolumeRestore
getVolumeRestore(GetVolumeRestoreRequest request)
Retrieve the details of a single VolumeRestore.VolumeRestore
getVolumeRestore(VolumeRestoreName name)
Retrieve the details of a single VolumeRestore.VolumeRestore
getVolumeRestore(String name)
Retrieve the details of a single VolumeRestore.com.google.api.gax.rpc.UnaryCallable<GetVolumeRestoreRequest,VolumeRestore>
getVolumeRestoreCallable()
Retrieve the details of a single VolumeRestore.boolean
isShutdown()
boolean
isTerminated()
BackupForGKEClient.ListBackupPlansPagedResponse
listBackupPlans(ListBackupPlansRequest request)
Lists BackupPlans in a given location.BackupForGKEClient.ListBackupPlansPagedResponse
listBackupPlans(LocationName parent)
Lists BackupPlans in a given location.BackupForGKEClient.ListBackupPlansPagedResponse
listBackupPlans(String parent)
Lists BackupPlans in a given location.com.google.api.gax.rpc.UnaryCallable<ListBackupPlansRequest,ListBackupPlansResponse>
listBackupPlansCallable()
Lists BackupPlans in a given location.com.google.api.gax.rpc.UnaryCallable<ListBackupPlansRequest,BackupForGKEClient.ListBackupPlansPagedResponse>
listBackupPlansPagedCallable()
Lists BackupPlans in a given location.BackupForGKEClient.ListBackupsPagedResponse
listBackups(BackupPlanName parent)
Lists the Backups for a given BackupPlan.BackupForGKEClient.ListBackupsPagedResponse
listBackups(ListBackupsRequest request)
Lists the Backups for a given BackupPlan.BackupForGKEClient.ListBackupsPagedResponse
listBackups(String parent)
Lists the Backups for a given BackupPlan.com.google.api.gax.rpc.UnaryCallable<ListBackupsRequest,ListBackupsResponse>
listBackupsCallable()
Lists the Backups for a given BackupPlan.com.google.api.gax.rpc.UnaryCallable<ListBackupsRequest,BackupForGKEClient.ListBackupsPagedResponse>
listBackupsPagedCallable()
Lists the Backups for a given BackupPlan.BackupForGKEClient.ListLocationsPagedResponse
listLocations(com.google.cloud.location.ListLocationsRequest request)
Lists information about the supported locations for this service.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>
listLocationsCallable()
Lists information about the supported locations for this service.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,BackupForGKEClient.ListLocationsPagedResponse>
listLocationsPagedCallable()
Lists information about the supported locations for this service.BackupForGKEClient.ListRestorePlansPagedResponse
listRestorePlans(ListRestorePlansRequest request)
Lists RestorePlans in a given location.BackupForGKEClient.ListRestorePlansPagedResponse
listRestorePlans(LocationName parent)
Lists RestorePlans in a given location.BackupForGKEClient.ListRestorePlansPagedResponse
listRestorePlans(String parent)
Lists RestorePlans in a given location.com.google.api.gax.rpc.UnaryCallable<ListRestorePlansRequest,ListRestorePlansResponse>
listRestorePlansCallable()
Lists RestorePlans in a given location.com.google.api.gax.rpc.UnaryCallable<ListRestorePlansRequest,BackupForGKEClient.ListRestorePlansPagedResponse>
listRestorePlansPagedCallable()
Lists RestorePlans in a given location.BackupForGKEClient.ListRestoresPagedResponse
listRestores(ListRestoresRequest request)
Lists the Restores for a given RestorePlan.BackupForGKEClient.ListRestoresPagedResponse
listRestores(RestorePlanName parent)
Lists the Restores for a given RestorePlan.BackupForGKEClient.ListRestoresPagedResponse
listRestores(String parent)
Lists the Restores for a given RestorePlan.com.google.api.gax.rpc.UnaryCallable<ListRestoresRequest,ListRestoresResponse>
listRestoresCallable()
Lists the Restores for a given RestorePlan.com.google.api.gax.rpc.UnaryCallable<ListRestoresRequest,BackupForGKEClient.ListRestoresPagedResponse>
listRestoresPagedCallable()
Lists the Restores for a given RestorePlan.BackupForGKEClient.ListVolumeBackupsPagedResponse
listVolumeBackups(BackupName parent)
Lists the VolumeBackups for a given Backup.BackupForGKEClient.ListVolumeBackupsPagedResponse
listVolumeBackups(ListVolumeBackupsRequest request)
Lists the VolumeBackups for a given Backup.BackupForGKEClient.ListVolumeBackupsPagedResponse
listVolumeBackups(String parent)
Lists the VolumeBackups for a given Backup.com.google.api.gax.rpc.UnaryCallable<ListVolumeBackupsRequest,ListVolumeBackupsResponse>
listVolumeBackupsCallable()
Lists the VolumeBackups for a given Backup.com.google.api.gax.rpc.UnaryCallable<ListVolumeBackupsRequest,BackupForGKEClient.ListVolumeBackupsPagedResponse>
listVolumeBackupsPagedCallable()
Lists the VolumeBackups for a given Backup.BackupForGKEClient.ListVolumeRestoresPagedResponse
listVolumeRestores(ListVolumeRestoresRequest request)
Lists the VolumeRestores for a given Restore.BackupForGKEClient.ListVolumeRestoresPagedResponse
listVolumeRestores(RestoreName parent)
Lists the VolumeRestores for a given Restore.BackupForGKEClient.ListVolumeRestoresPagedResponse
listVolumeRestores(String parent)
Lists the VolumeRestores for a given Restore.com.google.api.gax.rpc.UnaryCallable<ListVolumeRestoresRequest,ListVolumeRestoresResponse>
listVolumeRestoresCallable()
Lists the VolumeRestores for a given Restore.com.google.api.gax.rpc.UnaryCallable<ListVolumeRestoresRequest,BackupForGKEClient.ListVolumeRestoresPagedResponse>
listVolumeRestoresPagedCallable()
Lists the VolumeRestores for a given Restore.com.google.iam.v1.Policy
setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Sets the access control policy on the specified resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>
setIamPolicyCallable()
Sets the access control policy on the specified resource.void
shutdown()
void
shutdownNow()
com.google.iam.v1.TestIamPermissionsResponse
testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Returns permissions that a caller has on the specified resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>
testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource.com.google.api.gax.longrunning.OperationFuture<Backup,OperationMetadata>
updateBackupAsync(Backup backup, com.google.protobuf.FieldMask updateMask)
Update a Backup.com.google.api.gax.longrunning.OperationFuture<Backup,OperationMetadata>
updateBackupAsync(UpdateBackupRequest request)
Update a Backup.com.google.api.gax.rpc.UnaryCallable<UpdateBackupRequest,com.google.longrunning.Operation>
updateBackupCallable()
Update a Backup.com.google.api.gax.rpc.OperationCallable<UpdateBackupRequest,Backup,OperationMetadata>
updateBackupOperationCallable()
Update a Backup.com.google.api.gax.longrunning.OperationFuture<BackupPlan,OperationMetadata>
updateBackupPlanAsync(BackupPlan backupPlan, com.google.protobuf.FieldMask updateMask)
Update a BackupPlan.com.google.api.gax.longrunning.OperationFuture<BackupPlan,OperationMetadata>
updateBackupPlanAsync(UpdateBackupPlanRequest request)
Update a BackupPlan.com.google.api.gax.rpc.UnaryCallable<UpdateBackupPlanRequest,com.google.longrunning.Operation>
updateBackupPlanCallable()
Update a BackupPlan.com.google.api.gax.rpc.OperationCallable<UpdateBackupPlanRequest,BackupPlan,OperationMetadata>
updateBackupPlanOperationCallable()
Update a BackupPlan.com.google.api.gax.longrunning.OperationFuture<Restore,OperationMetadata>
updateRestoreAsync(Restore restore, com.google.protobuf.FieldMask updateMask)
Update a Restore.com.google.api.gax.longrunning.OperationFuture<Restore,OperationMetadata>
updateRestoreAsync(UpdateRestoreRequest request)
Update a Restore.com.google.api.gax.rpc.UnaryCallable<UpdateRestoreRequest,com.google.longrunning.Operation>
updateRestoreCallable()
Update a Restore.com.google.api.gax.rpc.OperationCallable<UpdateRestoreRequest,Restore,OperationMetadata>
updateRestoreOperationCallable()
Update a Restore.com.google.api.gax.longrunning.OperationFuture<RestorePlan,OperationMetadata>
updateRestorePlanAsync(RestorePlan restorePlan, com.google.protobuf.FieldMask updateMask)
Update a RestorePlan.com.google.api.gax.longrunning.OperationFuture<RestorePlan,OperationMetadata>
updateRestorePlanAsync(UpdateRestorePlanRequest request)
Update a RestorePlan.com.google.api.gax.rpc.UnaryCallable<UpdateRestorePlanRequest,com.google.longrunning.Operation>
updateRestorePlanCallable()
Update a RestorePlan.com.google.api.gax.rpc.OperationCallable<UpdateRestorePlanRequest,RestorePlan,OperationMetadata>
updateRestorePlanOperationCallable()
Update a RestorePlan.
-
-
-
Constructor Detail
-
BackupForGKEClient
protected BackupForGKEClient(BackupForGKESettings settings) throws IOException
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.- Throws:
IOException
-
BackupForGKEClient
protected BackupForGKEClient(BackupForGKEStub stub)
-
-
Method Detail
-
create
public static final BackupForGKEClient create() throws IOException
Constructs an instance of BackupForGKEClient with default settings.- Throws:
IOException
-
create
public static final BackupForGKEClient create(BackupForGKESettings settings) throws IOException
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.- Throws:
IOException
-
create
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).
-
getSettings
public final BackupForGKESettings getSettings()
-
getStub
public BackupForGKEStub getStub()
-
getOperationsClient
public final com.google.longrunning.OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
getHttpJsonOperationsClient
@BetaApi public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
createBackupPlanAsync
public final com.google.api.gax.longrunning.OperationFuture<BackupPlan,OperationMetadata> createBackupPlanAsync(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:
parent
- Required. The location within which to create the BackupPlan. Format: `projects/*/locations/*`backupPlan
- Required. The BackupPlan resource object to create.backupPlanId
- 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
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createBackupPlanAsync
public final com.google.api.gax.longrunning.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:
parent
- Required. The location within which to create the BackupPlan. Format: `projects/*/locations/*`backupPlan
- Required. The BackupPlan resource object to create.backupPlanId
- 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
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createBackupPlanAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createBackupPlanOperationCallable
public final com.google.api.gax.rpc.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(); }
-
createBackupPlanCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateBackupPlanRequest,com.google.longrunning.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(); }
-
listBackupPlans
public final BackupForGKEClient.ListBackupPlansPagedResponse listBackupPlans(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); } }
- Parameters:
parent
- Required. The location that contains the BackupPlans to list. Format: `projects/*/locations/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listBackupPlans
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); } }
- Parameters:
parent
- Required. The location that contains the BackupPlans to list. Format: `projects/*/locations/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listBackupPlans
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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listBackupPlansPagedCallable
public final com.google.api.gax.rpc.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); } }
-
listBackupPlansCallable
public final com.google.api.gax.rpc.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; } } }
-
getBackupPlan
public final BackupPlan getBackupPlan(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); }
- Parameters:
name
- Required. Fully qualified BackupPlan name. Format: `projects/*/locations/*/backupPlans/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getBackupPlan
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); }
- Parameters:
name
- Required. Fully qualified BackupPlan name. Format: `projects/*/locations/*/backupPlans/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getBackupPlan
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getBackupPlanCallable
public final com.google.api.gax.rpc.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(); }
-
updateBackupPlanAsync
public final com.google.api.gax.longrunning.OperationFuture<BackupPlan,OperationMetadata> updateBackupPlanAsync(BackupPlan backupPlan, com.google.protobuf.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:
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
- 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.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateBackupPlanAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateBackupPlanOperationCallable
public final com.google.api.gax.rpc.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(); }
-
updateBackupPlanCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateBackupPlanRequest,com.google.longrunning.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(); }
-
deleteBackupPlanAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteBackupPlanAsync(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(); }
- Parameters:
name
- Required. Fully qualified BackupPlan name. Format: `projects/*/locations/*/backupPlans/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteBackupPlanAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
name
- Required. Fully qualified BackupPlan name. Format: `projects/*/locations/*/backupPlans/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteBackupPlanAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteBackupPlanOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteBackupPlanRequest,com.google.protobuf.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(); }
-
deleteBackupPlanCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteBackupPlanRequest,com.google.longrunning.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(); }
-
createBackupAsync
public final com.google.api.gax.longrunning.OperationFuture<Backup,OperationMetadata> createBackupAsync(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:
parent
- Required. The BackupPlan within which to create the Backup. Format: `projects/*/locations/*/backupPlans/*`backup
- The Backup resource to create.backupId
- 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
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createBackupAsync
public final com.google.api.gax.longrunning.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:
parent
- Required. The BackupPlan within which to create the Backup. Format: `projects/*/locations/*/backupPlans/*`backup
- The Backup resource to create.backupId
- 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
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createBackupAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createBackupOperationCallable
public final com.google.api.gax.rpc.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(); }
-
createBackupCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateBackupRequest,com.google.longrunning.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(); }
-
listBackups
public final BackupForGKEClient.ListBackupsPagedResponse listBackups(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); } }
- Parameters:
parent
- Required. The BackupPlan that contains the Backups to list. Format: `projects/*/locations/*/backupPlans/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listBackups
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); } }
- Parameters:
parent
- Required. The BackupPlan that contains the Backups to list. Format: `projects/*/locations/*/backupPlans/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listBackups
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") .build(); for (Backup element : backupForGKEClient.listBackups(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listBackupsPagedCallable
public final com.google.api.gax.rpc.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") .build(); ApiFuture<Backup> future = backupForGKEClient.listBackupsPagedCallable().futureCall(request); // Do something. for (Backup element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listBackupsCallable
public final com.google.api.gax.rpc.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") .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; } } }
-
getBackup
public final Backup getBackup(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); }
- Parameters:
name
- Required. Full name of the Backup resource. Format: `projects/*/locations/*/backupPlans/*/backups/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getBackup
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); }
- Parameters:
name
- Required. Full name of the Backup resource. Format: `projects/*/locations/*/backupPlans/*/backups/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getBackup
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getBackupCallable
public final com.google.api.gax.rpc.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(); }
-
updateBackupAsync
public final com.google.api.gax.longrunning.OperationFuture<Backup,OperationMetadata> updateBackupAsync(Backup backup, com.google.protobuf.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:
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
- 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.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateBackupAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateBackupOperationCallable
public final com.google.api.gax.rpc.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(); }
-
updateBackupCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateBackupRequest,com.google.longrunning.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(); }
-
deleteBackupAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteBackupAsync(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(); }
- Parameters:
name
- Required. Name of the Backup resource. Format: `projects/*/locations/*/backupPlans/*/backups/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteBackupAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
name
- Required. Name of the Backup resource. Format: `projects/*/locations/*/backupPlans/*/backups/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteBackupAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteBackupOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteBackupRequest,com.google.protobuf.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(); }
-
deleteBackupCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteBackupRequest,com.google.longrunning.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(); }
-
listVolumeBackups
public final BackupForGKEClient.ListVolumeBackupsPagedResponse listVolumeBackups(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); } }
- Parameters:
parent
- Required. The Backup that contains the VolumeBackups to list. Format: `projects/*/locations/*/backupPlans/*/backups/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listVolumeBackups
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); } }
- Parameters:
parent
- Required. The Backup that contains the VolumeBackups to list. Format: `projects/*/locations/*/backupPlans/*/backups/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listVolumeBackups
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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listVolumeBackupsPagedCallable
public final com.google.api.gax.rpc.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); } }
-
listVolumeBackupsCallable
public final com.google.api.gax.rpc.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; } } }
-
getVolumeBackup
public final VolumeBackup getVolumeBackup(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); }
- Parameters:
name
- Required. Full name of the VolumeBackup resource. Format: `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getVolumeBackup
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); }
- Parameters:
name
- Required. Full name of the VolumeBackup resource. Format: `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getVolumeBackup
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getVolumeBackupCallable
public final com.google.api.gax.rpc.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(); }
-
createRestorePlanAsync
public final com.google.api.gax.longrunning.OperationFuture<RestorePlan,OperationMetadata> createRestorePlanAsync(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:
parent
- Required. The location within which to create the RestorePlan. Format: `projects/*/locations/*`restorePlan
- Required. The RestorePlan resource object to create.restorePlanId
- 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
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createRestorePlanAsync
public final com.google.api.gax.longrunning.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:
parent
- Required. The location within which to create the RestorePlan. Format: `projects/*/locations/*`restorePlan
- Required. The RestorePlan resource object to create.restorePlanId
- 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
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createRestorePlanAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createRestorePlanOperationCallable
public final com.google.api.gax.rpc.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(); }
-
createRestorePlanCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateRestorePlanRequest,com.google.longrunning.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(); }
-
listRestorePlans
public final BackupForGKEClient.ListRestorePlansPagedResponse listRestorePlans(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); } }
- Parameters:
parent
- Required. The location that contains the RestorePlans to list. Format: `projects/*/locations/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listRestorePlans
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); } }
- Parameters:
parent
- Required. The location that contains the RestorePlans to list. Format: `projects/*/locations/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listRestorePlans
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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listRestorePlansPagedCallable
public final com.google.api.gax.rpc.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); } }
-
listRestorePlansCallable
public final com.google.api.gax.rpc.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; } } }
-
getRestorePlan
public final RestorePlan getRestorePlan(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); }
- Parameters:
name
- Required. Fully qualified RestorePlan name. Format: `projects/*/locations/*/restorePlans/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getRestorePlan
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); }
- Parameters:
name
- Required. Fully qualified RestorePlan name. Format: `projects/*/locations/*/restorePlans/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getRestorePlan
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getRestorePlanCallable
public final com.google.api.gax.rpc.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(); }
-
updateRestorePlanAsync
public final com.google.api.gax.longrunning.OperationFuture<RestorePlan,OperationMetadata> updateRestorePlanAsync(RestorePlan restorePlan, com.google.protobuf.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:
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
- 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.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateRestorePlanAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateRestorePlanOperationCallable
public final com.google.api.gax.rpc.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(); }
-
updateRestorePlanCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateRestorePlanRequest,com.google.longrunning.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(); }
-
deleteRestorePlanAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteRestorePlanAsync(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(); }
- Parameters:
name
- Required. Fully qualified RestorePlan name. Format: `projects/*/locations/*/restorePlans/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteRestorePlanAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
name
- Required. Fully qualified RestorePlan name. Format: `projects/*/locations/*/restorePlans/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteRestorePlanAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteRestorePlanOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteRestorePlanRequest,com.google.protobuf.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(); }
-
deleteRestorePlanCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteRestorePlanRequest,com.google.longrunning.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(); }
-
createRestoreAsync
public final com.google.api.gax.longrunning.OperationFuture<Restore,OperationMetadata> createRestoreAsync(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:
parent
- Required. The RestorePlan within which to create the Restore. Format: `projects/*/locations/*/restorePlans/*`restore
- Required. The restore resource to create.restoreId
- 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.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createRestoreAsync
public final com.google.api.gax.longrunning.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:
parent
- Required. The RestorePlan within which to create the Restore. Format: `projects/*/locations/*/restorePlans/*`restore
- Required. The restore resource to create.restoreId
- 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.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createRestoreAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createRestoreOperationCallable
public final com.google.api.gax.rpc.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(); }
-
createRestoreCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateRestoreRequest,com.google.longrunning.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(); }
-
listRestores
public final BackupForGKEClient.ListRestoresPagedResponse listRestores(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); } }
- Parameters:
parent
- Required. The RestorePlan that contains the Restores to list. Format: `projects/*/locations/*/restorePlans/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listRestores
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); } }
- Parameters:
parent
- Required. The RestorePlan that contains the Restores to list. Format: `projects/*/locations/*/restorePlans/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listRestores
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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listRestoresPagedCallable
public final com.google.api.gax.rpc.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); } }
-
listRestoresCallable
public final com.google.api.gax.rpc.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; } } }
-
getRestore
public final Restore getRestore(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); }
- Parameters:
name
- Required. Name of the restore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getRestore
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); }
- Parameters:
name
- Required. Name of the restore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getRestore
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getRestoreCallable
public final com.google.api.gax.rpc.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(); }
-
updateRestoreAsync
public final com.google.api.gax.longrunning.OperationFuture<Restore,OperationMetadata> updateRestoreAsync(Restore restore, com.google.protobuf.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:
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
- 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.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateRestoreAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateRestoreOperationCallable
public final com.google.api.gax.rpc.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(); }
-
updateRestoreCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateRestoreRequest,com.google.longrunning.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(); }
-
deleteRestoreAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteRestoreAsync(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(); }
- Parameters:
name
- Required. Full name of the Restore Format: `projects/*/locations/*/restorePlans/*/restores/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteRestoreAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
name
- Required. Full name of the Restore Format: `projects/*/locations/*/restorePlans/*/restores/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteRestoreAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteRestoreOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteRestoreRequest,com.google.protobuf.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(); }
-
deleteRestoreCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteRestoreRequest,com.google.longrunning.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(); }
-
listVolumeRestores
public final BackupForGKEClient.ListVolumeRestoresPagedResponse listVolumeRestores(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); } }
- Parameters:
parent
- Required. The Restore that contains the VolumeRestores to list. Format: `projects/*/locations/*/restorePlans/*/restores/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listVolumeRestores
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); } }
- Parameters:
parent
- Required. The Restore that contains the VolumeRestores to list. Format: `projects/*/locations/*/restorePlans/*/restores/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listVolumeRestores
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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listVolumeRestoresPagedCallable
public final com.google.api.gax.rpc.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); } }
-
listVolumeRestoresCallable
public final com.google.api.gax.rpc.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; } } }
-
getVolumeRestore
public final VolumeRestore getVolumeRestore(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); }
- Parameters:
name
- Required. Full name of the VolumeRestore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getVolumeRestore
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); }
- Parameters:
name
- Required. Full name of the VolumeRestore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getVolumeRestore
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getVolumeRestoreCallable
public final com.google.api.gax.rpc.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(); }
-
listLocations
public final BackupForGKEClient.ListLocationsPagedResponse listLocations(com.google.cloud.location.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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listLocationsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.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); } }
-
listLocationsCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.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; } } }
-
getLocation
public final com.google.cloud.location.Location getLocation(com.google.cloud.location.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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getLocationCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.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(); }
-
setIamPolicy
public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Sets the access control policy on the specified resource. Replacesany existing policy.Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicyCallable()
Sets the access control policy on the specified resource. Replacesany existing policy.Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
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(); }
-
getIamPolicy
public final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.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(); }
-
testIamPermissions
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
testIamPermissionsCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.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(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-