Class DatabaseAdminClient
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
The Cloud Spanner Database Admin API can be used to: * create, drop, and list databases * update the schema of pre-existing databases * create, delete and list backups for a database * restore a database from an existing backup
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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
DatabaseName name = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
Database response = databaseAdminClient.getDatabase(name);
}
Note: close() needs to be called on the DatabaseAdminClient 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 DatabaseAdminSettings 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
DatabaseAdminSettings databaseAdminSettings =
DatabaseAdminSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create(databaseAdminSettings);
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
DatabaseAdminSettings databaseAdminSettings =
DatabaseAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create(databaseAdminSettings);
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
DatabaseAdminSettings databaseAdminSettings =
DatabaseAdminSettings.newHttpJsonBuilder().build();
DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create(databaseAdminSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static class
-
Constructor Summary
ModifierConstructorDescriptionprotected
DatabaseAdminClient
(DatabaseAdminSettings settings) Constructs an instance of DatabaseAdminClient, using the given settings.protected
-
Method Summary
Modifier and TypeMethodDescriptionboolean
awaitTermination
(long duration, TimeUnit unit) final void
close()
final com.google.api.gax.longrunning.OperationFuture<Backup,
CopyBackupMetadata> copyBackupAsync
(CopyBackupRequest request) Starts copying a Cloud Spanner Backup.final com.google.api.gax.longrunning.OperationFuture<Backup,
CopyBackupMetadata> copyBackupAsync
(InstanceName parent, String backupId, BackupName sourceBackup, com.google.protobuf.Timestamp expireTime) Starts copying a Cloud Spanner Backup.final com.google.api.gax.longrunning.OperationFuture<Backup,
CopyBackupMetadata> copyBackupAsync
(InstanceName parent, String backupId, String sourceBackup, com.google.protobuf.Timestamp expireTime) Starts copying a Cloud Spanner Backup.final com.google.api.gax.longrunning.OperationFuture<Backup,
CopyBackupMetadata> copyBackupAsync
(String parent, String backupId, BackupName sourceBackup, com.google.protobuf.Timestamp expireTime) Starts copying a Cloud Spanner Backup.final com.google.api.gax.longrunning.OperationFuture<Backup,
CopyBackupMetadata> copyBackupAsync
(String parent, String backupId, String sourceBackup, com.google.protobuf.Timestamp expireTime) Starts copying a Cloud Spanner Backup.final com.google.api.gax.rpc.UnaryCallable<CopyBackupRequest,
com.google.longrunning.Operation> Starts copying a Cloud Spanner Backup.final com.google.api.gax.rpc.OperationCallable<CopyBackupRequest,
Backup, CopyBackupMetadata> Starts copying a Cloud Spanner Backup.static final DatabaseAdminClient
create()
Constructs an instance of DatabaseAdminClient with default settings.static final DatabaseAdminClient
create
(DatabaseAdminSettings settings) Constructs an instance of DatabaseAdminClient, using the given settings.static final DatabaseAdminClient
create
(DatabaseAdminStub stub) Constructs an instance of DatabaseAdminClient, using the given stub for making calls.final com.google.api.gax.longrunning.OperationFuture<Backup,
CreateBackupMetadata> createBackupAsync
(CreateBackupRequest request) Starts creating a new Cloud Spanner Backup.final com.google.api.gax.longrunning.OperationFuture<Backup,
CreateBackupMetadata> createBackupAsync
(InstanceName parent, Backup backup, String backupId) Starts creating a new Cloud Spanner Backup.final com.google.api.gax.longrunning.OperationFuture<Backup,
CreateBackupMetadata> createBackupAsync
(String parent, Backup backup, String backupId) Starts creating a new Cloud Spanner Backup.final com.google.api.gax.rpc.UnaryCallable<CreateBackupRequest,
com.google.longrunning.Operation> Starts creating a new Cloud Spanner Backup.final com.google.api.gax.rpc.OperationCallable<CreateBackupRequest,
Backup, CreateBackupMetadata> Starts creating a new Cloud Spanner Backup.final com.google.api.gax.longrunning.OperationFuture<Database,
CreateDatabaseMetadata> createDatabaseAsync
(CreateDatabaseRequest request) Creates a new Cloud Spanner database and starts to prepare it for serving.final com.google.api.gax.longrunning.OperationFuture<Database,
CreateDatabaseMetadata> createDatabaseAsync
(InstanceName parent, String createStatement) Creates a new Cloud Spanner database and starts to prepare it for serving.final com.google.api.gax.longrunning.OperationFuture<Database,
CreateDatabaseMetadata> createDatabaseAsync
(String parent, String createStatement) Creates a new Cloud Spanner database and starts to prepare it for serving.final com.google.api.gax.rpc.UnaryCallable<CreateDatabaseRequest,
com.google.longrunning.Operation> Creates a new Cloud Spanner database and starts to prepare it for serving.final com.google.api.gax.rpc.OperationCallable<CreateDatabaseRequest,
Database, CreateDatabaseMetadata> Creates a new Cloud Spanner database and starts to prepare it for serving.final void
deleteBackup
(BackupName name) Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].final void
deleteBackup
(DeleteBackupRequest request) Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].final void
deleteBackup
(String name) Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].final com.google.api.gax.rpc.UnaryCallable<DeleteBackupRequest,
com.google.protobuf.Empty> Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].final void
dropDatabase
(DatabaseName database) Drops (aka deletes) a Cloud Spanner database.final void
dropDatabase
(DropDatabaseRequest request) Drops (aka deletes) a Cloud Spanner database.final void
dropDatabase
(String database) Drops (aka deletes) a Cloud Spanner database.final com.google.api.gax.rpc.UnaryCallable<DropDatabaseRequest,
com.google.protobuf.Empty> Drops (aka deletes) a Cloud Spanner database.final Backup
getBackup
(BackupName name) Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].final Backup
getBackup
(GetBackupRequest request) Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].final Backup
Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].final com.google.api.gax.rpc.UnaryCallable<GetBackupRequest,
Backup> Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].final Database
getDatabase
(DatabaseName name) Gets the state of a Cloud Spanner database.final Database
getDatabase
(GetDatabaseRequest request) Gets the state of a Cloud Spanner database.final Database
getDatabase
(String name) Gets the state of a Cloud Spanner database.final com.google.api.gax.rpc.UnaryCallable<GetDatabaseRequest,
Database> Gets the state of a Cloud Spanner database.final GetDatabaseDdlResponse
getDatabaseDdl
(DatabaseName database) Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.final GetDatabaseDdlResponse
getDatabaseDdl
(GetDatabaseDdlRequest request) Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.final GetDatabaseDdlResponse
getDatabaseDdl
(String database) Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.final com.google.api.gax.rpc.UnaryCallable<GetDatabaseDdlRequest,
GetDatabaseDdlResponse> Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.final com.google.api.gax.httpjson.longrunning.OperationsClient
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.final com.google.iam.v1.Policy
getIamPolicy
(com.google.api.resourcenames.ResourceName resource) Gets the access control policy for a database or backup resource.final com.google.iam.v1.Policy
getIamPolicy
(com.google.iam.v1.GetIamPolicyRequest request) Gets the access control policy for a database or backup resource.final com.google.iam.v1.Policy
getIamPolicy
(String resource) Gets the access control policy for a database or backup resource.final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,
com.google.iam.v1.Policy> Gets the access control policy for a database or backup resource.final com.google.longrunning.OperationsClient
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.final DatabaseAdminSettings
getStub()
boolean
boolean
listBackupOperations
(InstanceName parent) Lists the backup [long-running operations][google.longrunning.Operation] in the given instance.Lists the backup [long-running operations][google.longrunning.Operation] in the given instance.listBackupOperations
(String parent) Lists the backup [long-running operations][google.longrunning.Operation] in the given instance.final com.google.api.gax.rpc.UnaryCallable<ListBackupOperationsRequest,
ListBackupOperationsResponse> Lists the backup [long-running operations][google.longrunning.Operation] in the given instance.final com.google.api.gax.rpc.UnaryCallable<ListBackupOperationsRequest,
DatabaseAdminClient.ListBackupOperationsPagedResponse> Lists the backup [long-running operations][google.longrunning.Operation] in the given instance.listBackups
(InstanceName parent) Lists completed and pending backups.listBackups
(ListBackupsRequest request) Lists completed and pending backups.listBackups
(String parent) Lists completed and pending backups.final com.google.api.gax.rpc.UnaryCallable<ListBackupsRequest,
ListBackupsResponse> Lists completed and pending backups.final com.google.api.gax.rpc.UnaryCallable<ListBackupsRequest,
DatabaseAdminClient.ListBackupsPagedResponse> Lists completed and pending backups.listDatabaseOperations
(InstanceName parent) Lists database [longrunning-operations][google.longrunning.Operation].Lists database [longrunning-operations][google.longrunning.Operation].listDatabaseOperations
(String parent) Lists database [longrunning-operations][google.longrunning.Operation].final com.google.api.gax.rpc.UnaryCallable<ListDatabaseOperationsRequest,
ListDatabaseOperationsResponse> Lists database [longrunning-operations][google.longrunning.Operation].final com.google.api.gax.rpc.UnaryCallable<ListDatabaseOperationsRequest,
DatabaseAdminClient.ListDatabaseOperationsPagedResponse> Lists database [longrunning-operations][google.longrunning.Operation].listDatabaseRoles
(DatabaseName parent) Lists Cloud Spanner database roles.Lists Cloud Spanner database roles.listDatabaseRoles
(String parent) Lists Cloud Spanner database roles.final com.google.api.gax.rpc.UnaryCallable<ListDatabaseRolesRequest,
ListDatabaseRolesResponse> Lists Cloud Spanner database roles.final com.google.api.gax.rpc.UnaryCallable<ListDatabaseRolesRequest,
DatabaseAdminClient.ListDatabaseRolesPagedResponse> Lists Cloud Spanner database roles.listDatabases
(InstanceName parent) Lists Cloud Spanner databases.listDatabases
(ListDatabasesRequest request) Lists Cloud Spanner databases.listDatabases
(String parent) Lists Cloud Spanner databases.final com.google.api.gax.rpc.UnaryCallable<ListDatabasesRequest,
ListDatabasesResponse> Lists Cloud Spanner databases.final com.google.api.gax.rpc.UnaryCallable<ListDatabasesRequest,
DatabaseAdminClient.ListDatabasesPagedResponse> Lists Cloud Spanner databases.final com.google.api.gax.longrunning.OperationFuture<Database,
RestoreDatabaseMetadata> restoreDatabaseAsync
(InstanceName parent, String databaseId, BackupName backup) Create a new database by restoring from a completed backup.final com.google.api.gax.longrunning.OperationFuture<Database,
RestoreDatabaseMetadata> restoreDatabaseAsync
(InstanceName parent, String databaseId, String backup) Create a new database by restoring from a completed backup.final com.google.api.gax.longrunning.OperationFuture<Database,
RestoreDatabaseMetadata> Create a new database by restoring from a completed backup.final com.google.api.gax.longrunning.OperationFuture<Database,
RestoreDatabaseMetadata> restoreDatabaseAsync
(String parent, String databaseId, BackupName backup) Create a new database by restoring from a completed backup.final com.google.api.gax.longrunning.OperationFuture<Database,
RestoreDatabaseMetadata> restoreDatabaseAsync
(String parent, String databaseId, String backup) Create a new database by restoring from a completed backup.final com.google.api.gax.rpc.UnaryCallable<RestoreDatabaseRequest,
com.google.longrunning.Operation> Create a new database by restoring from a completed backup.final com.google.api.gax.rpc.OperationCallable<RestoreDatabaseRequest,
Database, RestoreDatabaseMetadata> Create a new database by restoring from a completed backup.final com.google.iam.v1.Policy
setIamPolicy
(com.google.api.resourcenames.ResourceName resource, com.google.iam.v1.Policy policy) Sets the access control policy on a database or backup resource.final com.google.iam.v1.Policy
setIamPolicy
(com.google.iam.v1.SetIamPolicyRequest request) Sets the access control policy on a database or backup resource.final com.google.iam.v1.Policy
setIamPolicy
(String resource, com.google.iam.v1.Policy policy) Sets the access control policy on a database or backup resource.final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,
com.google.iam.v1.Policy> Sets the access control policy on a database or backup resource.void
shutdown()
void
final com.google.iam.v1.TestIamPermissionsResponse
testIamPermissions
(com.google.api.resourcenames.ResourceName resource, List<String> permissions) Returns permissions that the caller has on the specified database or backup resource.final com.google.iam.v1.TestIamPermissionsResponse
testIamPermissions
(com.google.iam.v1.TestIamPermissionsRequest request) Returns permissions that the caller has on the specified database or backup resource.final com.google.iam.v1.TestIamPermissionsResponse
testIamPermissions
(String resource, List<String> permissions) Returns permissions that the caller has on the specified database or backup resource.final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,
com.google.iam.v1.TestIamPermissionsResponse> Returns permissions that the caller has on the specified database or backup resource.final Backup
updateBackup
(Backup backup, com.google.protobuf.FieldMask updateMask) Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].final Backup
updateBackup
(UpdateBackupRequest request) Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].final com.google.api.gax.rpc.UnaryCallable<UpdateBackupRequest,
Backup> Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].final com.google.api.gax.longrunning.OperationFuture<Database,
UpdateDatabaseMetadata> updateDatabaseAsync
(Database database, com.google.protobuf.FieldMask updateMask) Updates a Cloud Spanner database.final com.google.api.gax.longrunning.OperationFuture<Database,
UpdateDatabaseMetadata> updateDatabaseAsync
(UpdateDatabaseRequest request) Updates a Cloud Spanner database.final com.google.api.gax.rpc.UnaryCallable<UpdateDatabaseRequest,
com.google.longrunning.Operation> Updates a Cloud Spanner database.final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,
UpdateDatabaseDdlMetadata> updateDatabaseDdlAsync
(DatabaseName database, List<String> statements) Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,
UpdateDatabaseDdlMetadata> Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,
UpdateDatabaseDdlMetadata> updateDatabaseDdlAsync
(String database, List<String> statements) Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.final com.google.api.gax.rpc.UnaryCallable<UpdateDatabaseDdlRequest,
com.google.longrunning.Operation> Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.final com.google.api.gax.rpc.OperationCallable<UpdateDatabaseDdlRequest,
com.google.protobuf.Empty, UpdateDatabaseDdlMetadata> Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.final com.google.api.gax.rpc.OperationCallable<UpdateDatabaseRequest,
Database, UpdateDatabaseMetadata> Updates a Cloud Spanner database.
-
Constructor Details
-
DatabaseAdminClient
Constructs an instance of DatabaseAdminClient, 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
-
DatabaseAdminClient
-
-
Method Details
-
create
Constructs an instance of DatabaseAdminClient with default settings.- Throws:
IOException
-
create
Constructs an instance of DatabaseAdminClient, 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
Constructs an instance of DatabaseAdminClient, using the given stub for making calls. This is for advanced usage - prefer using create(DatabaseAdminSettings). -
getSettings
-
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. -
listDatabases
Lists Cloud Spanner databases.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]"); for (Database element : databaseAdminClient.listDatabases(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The instance whose databases should be listed. Values are of the form `projects/<project>/instances/<instance>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listDatabases
Lists Cloud Spanner databases.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString(); for (Database element : databaseAdminClient.listDatabases(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The instance whose databases should be listed. Values are of the form `projects/<project>/instances/<instance>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listDatabases
public final DatabaseAdminClient.ListDatabasesPagedResponse listDatabases(ListDatabasesRequest request) Lists Cloud Spanner databases.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { ListDatabasesRequest request = ListDatabasesRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (Database element : databaseAdminClient.listDatabases(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
-
listDatabasesPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListDatabasesRequest,DatabaseAdminClient.ListDatabasesPagedResponse> listDatabasesPagedCallable()Lists Cloud Spanner databases.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { ListDatabasesRequest request = ListDatabasesRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<Database> future = databaseAdminClient.listDatabasesPagedCallable().futureCall(request); // Do something. for (Database element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listDatabasesCallable
public final com.google.api.gax.rpc.UnaryCallable<ListDatabasesRequest,ListDatabasesResponse> listDatabasesCallable()Lists Cloud Spanner databases.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { ListDatabasesRequest request = ListDatabasesRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListDatabasesResponse response = databaseAdminClient.listDatabasesCallable().call(request); for (Database element : response.getDatabasesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
createDatabaseAsync
public final com.google.api.gax.longrunning.OperationFuture<Database,CreateDatabaseMetadata> createDatabaseAsync(InstanceName parent, String createStatement) Creates a new Cloud Spanner database and starts to prepare it for serving. The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<database_name>/operations/<operation_id>` and can be used to track preparation of the database. The [metadata][google.longrunning.Operation.metadata] field type is [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]"); String createStatement = "createStatement744686547"; Database response = databaseAdminClient.createDatabaseAsync(parent, createStatement).get(); }
- Parameters:
parent
- Required. The name of the instance that will serve the new database. Values are of the form `projects/<project>/instances/<instance>`.createStatement
- Required. A `CREATE DATABASE` statement, which specifies the ID of the new database. The database ID must conform to the regular expression `[a-z][a-z0-9_\\-]*[a-z0-9]` and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (`` ` ``).- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createDatabaseAsync
public final com.google.api.gax.longrunning.OperationFuture<Database,CreateDatabaseMetadata> createDatabaseAsync(String parent, String createStatement) Creates a new Cloud Spanner database and starts to prepare it for serving. The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<database_name>/operations/<operation_id>` and can be used to track preparation of the database. The [metadata][google.longrunning.Operation.metadata] field type is [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString(); String createStatement = "createStatement744686547"; Database response = databaseAdminClient.createDatabaseAsync(parent, createStatement).get(); }
- Parameters:
parent
- Required. The name of the instance that will serve the new database. Values are of the form `projects/<project>/instances/<instance>`.createStatement
- Required. A `CREATE DATABASE` statement, which specifies the ID of the new database. The database ID must conform to the regular expression `[a-z][a-z0-9_\\-]*[a-z0-9]` and be between 2 and 30 characters in length. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (`` ` ``).- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createDatabaseAsync
public final com.google.api.gax.longrunning.OperationFuture<Database,CreateDatabaseMetadata> createDatabaseAsync(CreateDatabaseRequest request) Creates a new Cloud Spanner database and starts to prepare it for serving. The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<database_name>/operations/<operation_id>` and can be used to track preparation of the database. The [metadata][google.longrunning.Operation.metadata] field type is [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { CreateDatabaseRequest request = CreateDatabaseRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setCreateStatement("createStatement744686547") .addAllExtraStatements(new ArrayList<String>()) .setEncryptionConfig(EncryptionConfig.newBuilder().build()) .setDatabaseDialect(DatabaseDialect.forNumber(0)) .build(); Database response = databaseAdminClient.createDatabaseAsync(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
-
createDatabaseOperationCallable
public final com.google.api.gax.rpc.OperationCallable<CreateDatabaseRequest,Database, createDatabaseOperationCallable()CreateDatabaseMetadata> Creates a new Cloud Spanner database and starts to prepare it for serving. The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<database_name>/operations/<operation_id>` and can be used to track preparation of the database. The [metadata][google.longrunning.Operation.metadata] field type is [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { CreateDatabaseRequest request = CreateDatabaseRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setCreateStatement("createStatement744686547") .addAllExtraStatements(new ArrayList<String>()) .setEncryptionConfig(EncryptionConfig.newBuilder().build()) .setDatabaseDialect(DatabaseDialect.forNumber(0)) .build(); OperationFuture<Database, CreateDatabaseMetadata> future = databaseAdminClient.createDatabaseOperationCallable().futureCall(request); // Do something. Database response = future.get(); }
-
createDatabaseCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateDatabaseRequest,com.google.longrunning.Operation> createDatabaseCallable()Creates a new Cloud Spanner database and starts to prepare it for serving. The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<database_name>/operations/<operation_id>` and can be used to track preparation of the database. The [metadata][google.longrunning.Operation.metadata] field type is [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { CreateDatabaseRequest request = CreateDatabaseRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setCreateStatement("createStatement744686547") .addAllExtraStatements(new ArrayList<String>()) .setEncryptionConfig(EncryptionConfig.newBuilder().build()) .setDatabaseDialect(DatabaseDialect.forNumber(0)) .build(); ApiFuture<Operation> future = databaseAdminClient.createDatabaseCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
getDatabase
Gets the state of a Cloud Spanner database.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { DatabaseName name = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]"); Database response = databaseAdminClient.getDatabase(name); }
- Parameters:
name
- Required. The name of the requested database. Values are of the form `projects/<project>/instances/<instance>/databases/<database>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getDatabase
Gets the state of a Cloud Spanner database.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String name = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString(); Database response = databaseAdminClient.getDatabase(name); }
- Parameters:
name
- Required. The name of the requested database. Values are of the form `projects/<project>/instances/<instance>/databases/<database>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getDatabase
Gets the state of a Cloud Spanner database.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { GetDatabaseRequest request = GetDatabaseRequest.newBuilder() .setName(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString()) .build(); Database response = databaseAdminClient.getDatabase(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
-
getDatabaseCallable
public final com.google.api.gax.rpc.UnaryCallable<GetDatabaseRequest,Database> getDatabaseCallable()Gets the state of a Cloud Spanner database.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { GetDatabaseRequest request = GetDatabaseRequest.newBuilder() .setName(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString()) .build(); ApiFuture<Database> future = databaseAdminClient.getDatabaseCallable().futureCall(request); // Do something. Database response = future.get(); }
-
updateDatabaseAsync
public final com.google.api.gax.longrunning.OperationFuture<Database,UpdateDatabaseMetadata> updateDatabaseAsync(Database database, com.google.protobuf.FieldMask updateMask) Updates a Cloud Spanner database. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the database. If the named database does not exist, returns `NOT_FOUND`.While the operation is pending:
* The database's [reconciling][google.spanner.admin.database.v1.Database.reconciling] field is set to true. * Cancelling the operation is best-effort. If the cancellation succeeds, the operation metadata's [cancel_time][google.spanner.admin.database.v1.UpdateDatabaseMetadata.cancel_time] is set, the updates are reverted, and the operation terminates with a `CANCELLED` status. * New UpdateDatabase requests will return a `FAILED_PRECONDITION` error until the pending operation is done (returns successfully or with error). * Reading the database via the API continues to give the pre-request values.
Upon completion of the returned operation:
* The new values are in effect and readable via the API. * The database's [reconciling][google.spanner.admin.database.v1.Database.reconciling] field becomes false.
The returned [long-running operation][google.longrunning.Operation] will have a name of the format `projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>` and can be used to track the database modification. The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseMetadata][google.spanner.admin.database.v1.UpdateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { Database database = Database.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); Database response = databaseAdminClient.updateDatabaseAsync(database, updateMask).get(); }
- Parameters:
database
- Required. The database to update. The `name` field of the database is of the form `projects/<project>/instances/<instance>/databases/<database>`.updateMask
- Required. The list of fields to update. Currently, only `enable_drop_protection` field can be updated.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateDatabaseAsync
public final com.google.api.gax.longrunning.OperationFuture<Database,UpdateDatabaseMetadata> updateDatabaseAsync(UpdateDatabaseRequest request) Updates a Cloud Spanner database. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the database. If the named database does not exist, returns `NOT_FOUND`.While the operation is pending:
* The database's [reconciling][google.spanner.admin.database.v1.Database.reconciling] field is set to true. * Cancelling the operation is best-effort. If the cancellation succeeds, the operation metadata's [cancel_time][google.spanner.admin.database.v1.UpdateDatabaseMetadata.cancel_time] is set, the updates are reverted, and the operation terminates with a `CANCELLED` status. * New UpdateDatabase requests will return a `FAILED_PRECONDITION` error until the pending operation is done (returns successfully or with error). * Reading the database via the API continues to give the pre-request values.
Upon completion of the returned operation:
* The new values are in effect and readable via the API. * The database's [reconciling][google.spanner.admin.database.v1.Database.reconciling] field becomes false.
The returned [long-running operation][google.longrunning.Operation] will have a name of the format `projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>` and can be used to track the database modification. The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseMetadata][google.spanner.admin.database.v1.UpdateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { UpdateDatabaseRequest request = UpdateDatabaseRequest.newBuilder() .setDatabase(Database.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); Database response = databaseAdminClient.updateDatabaseAsync(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
-
updateDatabaseOperationCallable
public final com.google.api.gax.rpc.OperationCallable<UpdateDatabaseRequest,Database, updateDatabaseOperationCallable()UpdateDatabaseMetadata> Updates a Cloud Spanner database. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the database. If the named database does not exist, returns `NOT_FOUND`.While the operation is pending:
* The database's [reconciling][google.spanner.admin.database.v1.Database.reconciling] field is set to true. * Cancelling the operation is best-effort. If the cancellation succeeds, the operation metadata's [cancel_time][google.spanner.admin.database.v1.UpdateDatabaseMetadata.cancel_time] is set, the updates are reverted, and the operation terminates with a `CANCELLED` status. * New UpdateDatabase requests will return a `FAILED_PRECONDITION` error until the pending operation is done (returns successfully or with error). * Reading the database via the API continues to give the pre-request values.
Upon completion of the returned operation:
* The new values are in effect and readable via the API. * The database's [reconciling][google.spanner.admin.database.v1.Database.reconciling] field becomes false.
The returned [long-running operation][google.longrunning.Operation] will have a name of the format `projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>` and can be used to track the database modification. The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseMetadata][google.spanner.admin.database.v1.UpdateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { UpdateDatabaseRequest request = UpdateDatabaseRequest.newBuilder() .setDatabase(Database.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); OperationFuture<Database, UpdateDatabaseMetadata> future = databaseAdminClient.updateDatabaseOperationCallable().futureCall(request); // Do something. Database response = future.get(); }
-
updateDatabaseCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateDatabaseRequest,com.google.longrunning.Operation> updateDatabaseCallable()Updates a Cloud Spanner database. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the database. If the named database does not exist, returns `NOT_FOUND`.While the operation is pending:
* The database's [reconciling][google.spanner.admin.database.v1.Database.reconciling] field is set to true. * Cancelling the operation is best-effort. If the cancellation succeeds, the operation metadata's [cancel_time][google.spanner.admin.database.v1.UpdateDatabaseMetadata.cancel_time] is set, the updates are reverted, and the operation terminates with a `CANCELLED` status. * New UpdateDatabase requests will return a `FAILED_PRECONDITION` error until the pending operation is done (returns successfully or with error). * Reading the database via the API continues to give the pre-request values.
Upon completion of the returned operation:
* The new values are in effect and readable via the API. * The database's [reconciling][google.spanner.admin.database.v1.Database.reconciling] field becomes false.
The returned [long-running operation][google.longrunning.Operation] will have a name of the format `projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>` and can be used to track the database modification. The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseMetadata][google.spanner.admin.database.v1.UpdateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { UpdateDatabaseRequest request = UpdateDatabaseRequest.newBuilder() .setDatabase(Database.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<Operation> future = databaseAdminClient.updateDatabaseCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
updateDatabaseDdlAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,UpdateDatabaseDdlMetadata> updateDatabaseDdlAsync(DatabaseName database, List<String> statements) Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<database_name>/operations/<operation_id>` and can be used to track execution of the schema change(s). The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]"); List<String> statements = new ArrayList<>(); databaseAdminClient.updateDatabaseDdlAsync(database, statements).get(); }
- Parameters:
database
- Required. The database to update.statements
- Required. DDL statements to be applied to the database.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateDatabaseDdlAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,UpdateDatabaseDdlMetadata> updateDatabaseDdlAsync(String database, List<String> statements) Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<database_name>/operations/<operation_id>` and can be used to track execution of the schema change(s). The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString(); List<String> statements = new ArrayList<>(); databaseAdminClient.updateDatabaseDdlAsync(database, statements).get(); }
- Parameters:
database
- Required. The database to update.statements
- Required. DDL statements to be applied to the database.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateDatabaseDdlAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,UpdateDatabaseDdlMetadata> updateDatabaseDdlAsync(UpdateDatabaseDdlRequest request) Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<database_name>/operations/<operation_id>` and can be used to track execution of the schema change(s). The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { UpdateDatabaseDdlRequest request = UpdateDatabaseDdlRequest.newBuilder() .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString()) .addAllStatements(new ArrayList<String>()) .setOperationId("operationId129704162") .build(); databaseAdminClient.updateDatabaseDdlAsync(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
-
updateDatabaseDdlOperationCallable
public final com.google.api.gax.rpc.OperationCallable<UpdateDatabaseDdlRequest,com.google.protobuf.Empty, updateDatabaseDdlOperationCallable()UpdateDatabaseDdlMetadata> Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<database_name>/operations/<operation_id>` and can be used to track execution of the schema change(s). The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { UpdateDatabaseDdlRequest request = UpdateDatabaseDdlRequest.newBuilder() .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString()) .addAllStatements(new ArrayList<String>()) .setOperationId("operationId129704162") .build(); OperationFuture<Empty, UpdateDatabaseDdlMetadata> future = databaseAdminClient.updateDatabaseDdlOperationCallable().futureCall(request); // Do something. future.get(); }
-
updateDatabaseDdlCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateDatabaseDdlRequest,com.google.longrunning.Operation> updateDatabaseDdlCallable()Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned [long-running operation][google.longrunning.Operation] will have a name of the format `<database_name>/operations/<operation_id>` and can be used to track execution of the schema change(s). The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { UpdateDatabaseDdlRequest request = UpdateDatabaseDdlRequest.newBuilder() .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString()) .addAllStatements(new ArrayList<String>()) .setOperationId("operationId129704162") .build(); ApiFuture<Operation> future = databaseAdminClient.updateDatabaseDdlCallable().futureCall(request); // Do something. future.get(); }
-
dropDatabase
Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their `expire_time`. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]"); databaseAdminClient.dropDatabase(database); }
- Parameters:
database
- Required. The database to be dropped.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
dropDatabase
Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their `expire_time`. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString(); databaseAdminClient.dropDatabase(database); }
- Parameters:
database
- Required. The database to be dropped.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
dropDatabase
Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their `expire_time`. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { DropDatabaseRequest request = DropDatabaseRequest.newBuilder() .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString()) .build(); databaseAdminClient.dropDatabase(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
-
dropDatabaseCallable
public final com.google.api.gax.rpc.UnaryCallable<DropDatabaseRequest,com.google.protobuf.Empty> dropDatabaseCallable()Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their `expire_time`. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { DropDatabaseRequest request = DropDatabaseRequest.newBuilder() .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString()) .build(); ApiFuture<Empty> future = databaseAdminClient.dropDatabaseCallable().futureCall(request); // Do something. future.get(); }
-
getDatabaseDdl
Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]"); GetDatabaseDdlResponse response = databaseAdminClient.getDatabaseDdl(database); }
- Parameters:
database
- Required. The database whose schema we wish to get. Values are of the form `projects/<project>/instances/<instance>/databases/<database>`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getDatabaseDdl
Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString(); GetDatabaseDdlResponse response = databaseAdminClient.getDatabaseDdl(database); }
- Parameters:
database
- Required. The database whose schema we wish to get. Values are of the form `projects/<project>/instances/<instance>/databases/<database>`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getDatabaseDdl
Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { GetDatabaseDdlRequest request = GetDatabaseDdlRequest.newBuilder() .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString()) .build(); GetDatabaseDdlResponse response = databaseAdminClient.getDatabaseDdl(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
-
getDatabaseDdlCallable
public final com.google.api.gax.rpc.UnaryCallable<GetDatabaseDdlRequest,GetDatabaseDdlResponse> getDatabaseDdlCallable()Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { GetDatabaseDdlRequest request = GetDatabaseDdlRequest.newBuilder() .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString()) .build(); ApiFuture<GetDatabaseDdlResponse> future = databaseAdminClient.getDatabaseDdlCallable().futureCall(request); // Do something. GetDatabaseDdlResponse response = future.get(); }
-
setIamPolicy
public final com.google.iam.v1.Policy setIamPolicy(com.google.api.resourcenames.ResourceName resource, com.google.iam.v1.Policy policy) Sets the access control policy on a database or backup resource. Replaces any existing policy.Authorization requires `spanner.databases.setIamPolicy` permission on [resource][google.iam.v1.SetIamPolicyRequest.resource]. For backups, authorization requires `spanner.backups.setIamPolicy` permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { ResourceName resource = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]"); Policy policy = Policy.newBuilder().build(); Policy response = databaseAdminClient.setIamPolicy(resource, policy); }
- Parameters:
resource
- REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.policy
- REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setIamPolicy
public final com.google.iam.v1.Policy setIamPolicy(String resource, com.google.iam.v1.Policy policy) Sets the access control policy on a database or backup resource. Replaces any existing policy.Authorization requires `spanner.databases.setIamPolicy` permission on [resource][google.iam.v1.SetIamPolicyRequest.resource]. For backups, authorization requires `spanner.backups.setIamPolicy` permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String resource = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString(); Policy policy = Policy.newBuilder().build(); Policy response = databaseAdminClient.setIamPolicy(resource, policy); }
- Parameters:
resource
- REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.policy
- REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setIamPolicy
public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request) Sets the access control policy on a database or backup resource. Replaces any existing policy.Authorization requires `spanner.databases.setIamPolicy` permission on [resource][google.iam.v1.SetIamPolicyRequest.resource]. For backups, authorization requires `spanner.backups.setIamPolicy` permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder() .setResource(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString()) .setPolicy(Policy.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); Policy response = databaseAdminClient.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 a database or backup resource. Replaces any existing policy.Authorization requires `spanner.databases.setIamPolicy` permission on [resource][google.iam.v1.SetIamPolicyRequest.resource]. For backups, authorization requires `spanner.backups.setIamPolicy` permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder() .setResource(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString()) .setPolicy(Policy.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<Policy> future = databaseAdminClient.setIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); }
-
getIamPolicy
public final com.google.iam.v1.Policy getIamPolicy(com.google.api.resourcenames.ResourceName resource) Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set.Authorization requires `spanner.databases.getIamPolicy` permission on [resource][google.iam.v1.GetIamPolicyRequest.resource]. For backups, authorization requires `spanner.backups.getIamPolicy` permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { ResourceName resource = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]"); Policy response = databaseAdminClient.getIamPolicy(resource); }
- Parameters:
resource
- REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getIamPolicy
Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set.Authorization requires `spanner.databases.getIamPolicy` permission on [resource][google.iam.v1.GetIamPolicyRequest.resource]. For backups, authorization requires `spanner.backups.getIamPolicy` permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String resource = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString(); Policy response = databaseAdminClient.getIamPolicy(resource); }
- Parameters:
resource
- REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getIamPolicy
public final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request) Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set.Authorization requires `spanner.databases.getIamPolicy` permission on [resource][google.iam.v1.GetIamPolicyRequest.resource]. For backups, authorization requires `spanner.backups.getIamPolicy` permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder() .setResource(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString()) .setOptions(GetPolicyOptions.newBuilder().build()) .build(); Policy response = databaseAdminClient.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 database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set.Authorization requires `spanner.databases.getIamPolicy` permission on [resource][google.iam.v1.GetIamPolicyRequest.resource]. For backups, authorization requires `spanner.backups.getIamPolicy` permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder() .setResource(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString()) .setOptions(GetPolicyOptions.newBuilder().build()) .build(); ApiFuture<Policy> future = databaseAdminClient.getIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); }
-
testIamPermissions
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.api.resourcenames.ResourceName resource, List<String> permissions) Returns permissions that the caller has on the specified database or backup resource.Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { ResourceName resource = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]"); List<String> permissions = new ArrayList<>(); TestIamPermissionsResponse response = databaseAdminClient.testIamPermissions(resource, permissions); }
- Parameters:
resource
- REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.permissions
- The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
testIamPermissions
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(String resource, List<String> permissions) Returns permissions that the caller has on the specified database or backup resource.Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String resource = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString(); List<String> permissions = new ArrayList<>(); TestIamPermissionsResponse response = databaseAdminClient.testIamPermissions(resource, permissions); }
- Parameters:
resource
- REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.permissions
- The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
testIamPermissions
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request) Returns permissions that the caller has on the specified database or backup resource.Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder() .setResource(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString()) .addAllPermissions(new ArrayList<String>()) .build(); TestIamPermissionsResponse response = databaseAdminClient.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 the caller has on the specified database or backup resource.Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder() .setResource(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString()) .addAllPermissions(new ArrayList<String>()) .build(); ApiFuture<TestIamPermissionsResponse> future = databaseAdminClient.testIamPermissionsCallable().futureCall(request); // Do something. TestIamPermissionsResponse response = future.get(); }
-
createBackupAsync
public final com.google.api.gax.longrunning.OperationFuture<Backup,CreateBackupMetadata> createBackupAsync(InstanceName parent, Backup backup, String backupId) Starts creating a new Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>` and can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]"); Backup backup = Backup.newBuilder().build(); String backupId = "backupId2121930365"; Backup response = databaseAdminClient.createBackupAsync(parent, backup, backupId).get(); }
- Parameters:
parent
- Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form `projects/<project>/instances/<instance>`.backup
- Required. The backup to create.backupId
- Required. The id of the backup to be created. The `backup_id` appended to `parent` forms the full backup name of the form `projects/<project>/instances/<instance>/backups/<backup_id>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createBackupAsync
public final com.google.api.gax.longrunning.OperationFuture<Backup,CreateBackupMetadata> createBackupAsync(String parent, Backup backup, String backupId) Starts creating a new Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>` and can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString(); Backup backup = Backup.newBuilder().build(); String backupId = "backupId2121930365"; Backup response = databaseAdminClient.createBackupAsync(parent, backup, backupId).get(); }
- Parameters:
parent
- Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form `projects/<project>/instances/<instance>`.backup
- Required. The backup to create.backupId
- Required. The id of the backup to be created. The `backup_id` appended to `parent` forms the full backup name of the form `projects/<project>/instances/<instance>/backups/<backup_id>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createBackupAsync
public final com.google.api.gax.longrunning.OperationFuture<Backup,CreateBackupMetadata> createBackupAsync(CreateBackupRequest request) Starts creating a new Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>` and can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { CreateBackupRequest request = CreateBackupRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setBackupId("backupId2121930365") .setBackup(Backup.newBuilder().build()) .setEncryptionConfig(CreateBackupEncryptionConfig.newBuilder().build()) .build(); Backup response = databaseAdminClient.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, createBackupOperationCallable()CreateBackupMetadata> Starts creating a new Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>` and can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { CreateBackupRequest request = CreateBackupRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setBackupId("backupId2121930365") .setBackup(Backup.newBuilder().build()) .setEncryptionConfig(CreateBackupEncryptionConfig.newBuilder().build()) .build(); OperationFuture<Backup, CreateBackupMetadata> future = databaseAdminClient.createBackupOperationCallable().futureCall(request); // Do something. Backup response = future.get(); }
-
createBackupCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateBackupRequest,com.google.longrunning.Operation> createBackupCallable()Starts creating a new Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>` and can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { CreateBackupRequest request = CreateBackupRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setBackupId("backupId2121930365") .setBackup(Backup.newBuilder().build()) .setEncryptionConfig(CreateBackupEncryptionConfig.newBuilder().build()) .build(); ApiFuture<Operation> future = databaseAdminClient.createBackupCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
copyBackupAsync
public final com.google.api.gax.longrunning.OperationFuture<Backup,CopyBackupMetadata> copyBackupAsync(InstanceName parent, String backupId, BackupName sourceBackup, com.google.protobuf.Timestamp expireTime) Starts copying a Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>` and can be used to track copying of the backup. The operation is associated with the destination backup. The [metadata][google.longrunning.Operation.metadata] field type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the copying and delete the backup. Concurrent CopyBackup requests can run on the same source 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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]"); String backupId = "backupId2121930365"; BackupName sourceBackup = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]"); Timestamp expireTime = Timestamp.newBuilder().build(); Backup response = databaseAdminClient.copyBackupAsync(parent, backupId, sourceBackup, expireTime).get(); }
- Parameters:
parent
- Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects/<project>/instances/<instance>`.backupId
- Required. The id of the backup copy. The `backup_id` appended to `parent` forms the full backup_uri of the form `projects/<project>/instances/<instance>/backups/<backup>`.sourceBackup
- Required. The source backup to be copied. The source backup needs to be in READY state for it to be copied. Once CopyBackup is in progress, the source backup cannot be deleted or cleaned up on expiration until CopyBackup is finished. Values are of the form: `projects/<project>/instances/<instance>/backups/<backup>`.expireTime
- Required. The expiration time of the backup in microsecond granularity. The expiration time must be at least 6 hours and at most 366 days from the `create_time` of the source backup. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
copyBackupAsync
public final com.google.api.gax.longrunning.OperationFuture<Backup,CopyBackupMetadata> copyBackupAsync(InstanceName parent, String backupId, String sourceBackup, com.google.protobuf.Timestamp expireTime) Starts copying a Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>` and can be used to track copying of the backup. The operation is associated with the destination backup. The [metadata][google.longrunning.Operation.metadata] field type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the copying and delete the backup. Concurrent CopyBackup requests can run on the same source 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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]"); String backupId = "backupId2121930365"; String sourceBackup = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString(); Timestamp expireTime = Timestamp.newBuilder().build(); Backup response = databaseAdminClient.copyBackupAsync(parent, backupId, sourceBackup, expireTime).get(); }
- Parameters:
parent
- Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects/<project>/instances/<instance>`.backupId
- Required. The id of the backup copy. The `backup_id` appended to `parent` forms the full backup_uri of the form `projects/<project>/instances/<instance>/backups/<backup>`.sourceBackup
- Required. The source backup to be copied. The source backup needs to be in READY state for it to be copied. Once CopyBackup is in progress, the source backup cannot be deleted or cleaned up on expiration until CopyBackup is finished. Values are of the form: `projects/<project>/instances/<instance>/backups/<backup>`.expireTime
- Required. The expiration time of the backup in microsecond granularity. The expiration time must be at least 6 hours and at most 366 days from the `create_time` of the source backup. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
copyBackupAsync
public final com.google.api.gax.longrunning.OperationFuture<Backup,CopyBackupMetadata> copyBackupAsync(String parent, String backupId, BackupName sourceBackup, com.google.protobuf.Timestamp expireTime) Starts copying a Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>` and can be used to track copying of the backup. The operation is associated with the destination backup. The [metadata][google.longrunning.Operation.metadata] field type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the copying and delete the backup. Concurrent CopyBackup requests can run on the same source 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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString(); String backupId = "backupId2121930365"; BackupName sourceBackup = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]"); Timestamp expireTime = Timestamp.newBuilder().build(); Backup response = databaseAdminClient.copyBackupAsync(parent, backupId, sourceBackup, expireTime).get(); }
- Parameters:
parent
- Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects/<project>/instances/<instance>`.backupId
- Required. The id of the backup copy. The `backup_id` appended to `parent` forms the full backup_uri of the form `projects/<project>/instances/<instance>/backups/<backup>`.sourceBackup
- Required. The source backup to be copied. The source backup needs to be in READY state for it to be copied. Once CopyBackup is in progress, the source backup cannot be deleted or cleaned up on expiration until CopyBackup is finished. Values are of the form: `projects/<project>/instances/<instance>/backups/<backup>`.expireTime
- Required. The expiration time of the backup in microsecond granularity. The expiration time must be at least 6 hours and at most 366 days from the `create_time` of the source backup. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
copyBackupAsync
public final com.google.api.gax.longrunning.OperationFuture<Backup,CopyBackupMetadata> copyBackupAsync(String parent, String backupId, String sourceBackup, com.google.protobuf.Timestamp expireTime) Starts copying a Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>` and can be used to track copying of the backup. The operation is associated with the destination backup. The [metadata][google.longrunning.Operation.metadata] field type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the copying and delete the backup. Concurrent CopyBackup requests can run on the same source 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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString(); String backupId = "backupId2121930365"; String sourceBackup = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString(); Timestamp expireTime = Timestamp.newBuilder().build(); Backup response = databaseAdminClient.copyBackupAsync(parent, backupId, sourceBackup, expireTime).get(); }
- Parameters:
parent
- Required. The name of the destination instance that will contain the backup copy. Values are of the form: `projects/<project>/instances/<instance>`.backupId
- Required. The id of the backup copy. The `backup_id` appended to `parent` forms the full backup_uri of the form `projects/<project>/instances/<instance>/backups/<backup>`.sourceBackup
- Required. The source backup to be copied. The source backup needs to be in READY state for it to be copied. Once CopyBackup is in progress, the source backup cannot be deleted or cleaned up on expiration until CopyBackup is finished. Values are of the form: `projects/<project>/instances/<instance>/backups/<backup>`.expireTime
- Required. The expiration time of the backup in microsecond granularity. The expiration time must be at least 6 hours and at most 366 days from the `create_time` of the source backup. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
copyBackupAsync
public final com.google.api.gax.longrunning.OperationFuture<Backup,CopyBackupMetadata> copyBackupAsync(CopyBackupRequest request) Starts copying a Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>` and can be used to track copying of the backup. The operation is associated with the destination backup. The [metadata][google.longrunning.Operation.metadata] field type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the copying and delete the backup. Concurrent CopyBackup requests can run on the same source 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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { CopyBackupRequest request = CopyBackupRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setBackupId("backupId2121930365") .setSourceBackup(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString()) .setExpireTime(Timestamp.newBuilder().build()) .setEncryptionConfig(CopyBackupEncryptionConfig.newBuilder().build()) .build(); Backup response = databaseAdminClient.copyBackupAsync(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
-
copyBackupOperationCallable
public final com.google.api.gax.rpc.OperationCallable<CopyBackupRequest,Backup, copyBackupOperationCallable()CopyBackupMetadata> Starts copying a Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>` and can be used to track copying of the backup. The operation is associated with the destination backup. The [metadata][google.longrunning.Operation.metadata] field type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the copying and delete the backup. Concurrent CopyBackup requests can run on the same source 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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { CopyBackupRequest request = CopyBackupRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setBackupId("backupId2121930365") .setSourceBackup(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString()) .setExpireTime(Timestamp.newBuilder().build()) .setEncryptionConfig(CopyBackupEncryptionConfig.newBuilder().build()) .build(); OperationFuture<Backup, CopyBackupMetadata> future = databaseAdminClient.copyBackupOperationCallable().futureCall(request); // Do something. Backup response = future.get(); }
-
copyBackupCallable
public final com.google.api.gax.rpc.UnaryCallable<CopyBackupRequest,com.google.longrunning.Operation> copyBackupCallable()Starts copying a Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>` and can be used to track copying of the backup. The operation is associated with the destination backup. The [metadata][google.longrunning.Operation.metadata] field type is [CopyBackupMetadata][google.spanner.admin.database.v1.CopyBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the copying and delete the backup. Concurrent CopyBackup requests can run on the same source 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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { CopyBackupRequest request = CopyBackupRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setBackupId("backupId2121930365") .setSourceBackup(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString()) .setExpireTime(Timestamp.newBuilder().build()) .setEncryptionConfig(CopyBackupEncryptionConfig.newBuilder().build()) .build(); ApiFuture<Operation> future = databaseAdminClient.copyBackupCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
getBackup
Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { BackupName name = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]"); Backup response = databaseAdminClient.getBackup(name); }
- Parameters:
name
- Required. Name of the backup. Values are of the form `projects/<project>/instances/<instance>/backups/<backup>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getBackup
Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String name = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString(); Backup response = databaseAdminClient.getBackup(name); }
- Parameters:
name
- Required. Name of the backup. Values are of the form `projects/<project>/instances/<instance>/backups/<backup>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getBackup
Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { GetBackupRequest request = GetBackupRequest.newBuilder() .setName(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString()) .build(); Backup response = databaseAdminClient.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
Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { GetBackupRequest request = GetBackupRequest.newBuilder() .setName(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString()) .build(); ApiFuture<Backup> future = databaseAdminClient.getBackupCallable().futureCall(request); // Do something. Backup response = future.get(); }
-
updateBackup
Updates a pending or completed [Backup][google.spanner.admin.database.v1.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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { Backup backup = Backup.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); Backup response = databaseAdminClient.updateBackup(backup, updateMask); }
- Parameters:
backup
- Required. The backup to update. `backup.name`, and the fields to be updated as specified by `update_mask` are required. Other fields are ignored. Update is only supported for the following fields: * `backup.expire_time`.updateMask
- Required. A mask specifying which fields (e.g. `expire_time`) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateBackup
Updates a pending or completed [Backup][google.spanner.admin.database.v1.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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { UpdateBackupRequest request = UpdateBackupRequest.newBuilder() .setBackup(Backup.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); Backup response = databaseAdminClient.updateBackup(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
-
updateBackupCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateBackupRequest,Backup> updateBackupCallable()Updates a pending or completed [Backup][google.spanner.admin.database.v1.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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { UpdateBackupRequest request = UpdateBackupRequest.newBuilder() .setBackup(Backup.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<Backup> future = databaseAdminClient.updateBackupCallable().futureCall(request); // Do something. Backup response = future.get(); }
-
deleteBackup
Deletes a pending or completed [Backup][google.spanner.admin.database.v1.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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { BackupName name = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]"); databaseAdminClient.deleteBackup(name); }
- Parameters:
name
- Required. Name of the backup to delete. Values are of the form `projects/<project>/instances/<instance>/backups/<backup>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteBackup
Deletes a pending or completed [Backup][google.spanner.admin.database.v1.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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String name = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString(); databaseAdminClient.deleteBackup(name); }
- Parameters:
name
- Required. Name of the backup to delete. Values are of the form `projects/<project>/instances/<instance>/backups/<backup>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteBackup
Deletes a pending or completed [Backup][google.spanner.admin.database.v1.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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { DeleteBackupRequest request = DeleteBackupRequest.newBuilder() .setName(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString()) .build(); databaseAdminClient.deleteBackup(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
-
deleteBackupCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteBackupRequest,com.google.protobuf.Empty> deleteBackupCallable()Deletes a pending or completed [Backup][google.spanner.admin.database.v1.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 (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { DeleteBackupRequest request = DeleteBackupRequest.newBuilder() .setName(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString()) .build(); ApiFuture<Empty> future = databaseAdminClient.deleteBackupCallable().futureCall(request); // Do something. future.get(); }
-
listBackups
Lists completed and pending backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]"); for (Backup element : databaseAdminClient.listBackups(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The instance to list backups from. Values are of the form `projects/<project>/instances/<instance>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listBackups
Lists completed and pending backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString(); for (Backup element : databaseAdminClient.listBackups(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The instance to list backups from. Values are of the form `projects/<project>/instances/<instance>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listBackups
Lists completed and pending backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { ListBackupsRequest request = ListBackupsRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (Backup element : databaseAdminClient.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,DatabaseAdminClient.ListBackupsPagedResponse> listBackupsPagedCallable()Lists completed and pending backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { ListBackupsRequest request = ListBackupsRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<Backup> future = databaseAdminClient.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 completed and pending backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { ListBackupsRequest request = ListBackupsRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListBackupsResponse response = databaseAdminClient.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; } } }
-
restoreDatabaseAsync
public final com.google.api.gax.longrunning.OperationFuture<Database,RestoreDatabaseMetadata> restoreDatabaseAsync(InstanceName parent, String databaseId, BackupName backup) Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database [long-running operation][google.longrunning.Operation] has a name of the format `projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>`, and can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is [Database][google.spanner.admin.database.v1.Database], if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]"); String databaseId = "databaseId1688905718"; BackupName backup = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]"); Database response = databaseAdminClient.restoreDatabaseAsync(parent, databaseId, backup).get(); }
- Parameters:
parent
- Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form `projects/<project>/instances/<instance>`.databaseId
- Required. The id of the database to create and restore to. This database must not already exist. The `database_id` appended to `parent` forms the full database name of the form `projects/<project>/instances/<instance>/databases/<database_id>`.backup
- Name of the backup from which to restore. Values are of the form `projects/<project>/instances/<instance>/backups/<backup>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
restoreDatabaseAsync
public final com.google.api.gax.longrunning.OperationFuture<Database,RestoreDatabaseMetadata> restoreDatabaseAsync(InstanceName parent, String databaseId, String backup) Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database [long-running operation][google.longrunning.Operation] has a name of the format `projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>`, and can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is [Database][google.spanner.admin.database.v1.Database], if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]"); String databaseId = "databaseId1688905718"; String backup = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString(); Database response = databaseAdminClient.restoreDatabaseAsync(parent, databaseId, backup).get(); }
- Parameters:
parent
- Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form `projects/<project>/instances/<instance>`.databaseId
- Required. The id of the database to create and restore to. This database must not already exist. The `database_id` appended to `parent` forms the full database name of the form `projects/<project>/instances/<instance>/databases/<database_id>`.backup
- Name of the backup from which to restore. Values are of the form `projects/<project>/instances/<instance>/backups/<backup>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
restoreDatabaseAsync
public final com.google.api.gax.longrunning.OperationFuture<Database,RestoreDatabaseMetadata> restoreDatabaseAsync(String parent, String databaseId, BackupName backup) Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database [long-running operation][google.longrunning.Operation] has a name of the format `projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>`, and can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is [Database][google.spanner.admin.database.v1.Database], if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString(); String databaseId = "databaseId1688905718"; BackupName backup = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]"); Database response = databaseAdminClient.restoreDatabaseAsync(parent, databaseId, backup).get(); }
- Parameters:
parent
- Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form `projects/<project>/instances/<instance>`.databaseId
- Required. The id of the database to create and restore to. This database must not already exist. The `database_id` appended to `parent` forms the full database name of the form `projects/<project>/instances/<instance>/databases/<database_id>`.backup
- Name of the backup from which to restore. Values are of the form `projects/<project>/instances/<instance>/backups/<backup>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
restoreDatabaseAsync
public final com.google.api.gax.longrunning.OperationFuture<Database,RestoreDatabaseMetadata> restoreDatabaseAsync(String parent, String databaseId, String backup) Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database [long-running operation][google.longrunning.Operation] has a name of the format `projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>`, and can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is [Database][google.spanner.admin.database.v1.Database], if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString(); String databaseId = "databaseId1688905718"; String backup = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString(); Database response = databaseAdminClient.restoreDatabaseAsync(parent, databaseId, backup).get(); }
- Parameters:
parent
- Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form `projects/<project>/instances/<instance>`.databaseId
- Required. The id of the database to create and restore to. This database must not already exist. The `database_id` appended to `parent` forms the full database name of the form `projects/<project>/instances/<instance>/databases/<database_id>`.backup
- Name of the backup from which to restore. Values are of the form `projects/<project>/instances/<instance>/backups/<backup>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
restoreDatabaseAsync
public final com.google.api.gax.longrunning.OperationFuture<Database,RestoreDatabaseMetadata> restoreDatabaseAsync(RestoreDatabaseRequest request) Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database [long-running operation][google.longrunning.Operation] has a name of the format `projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>`, and can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is [Database][google.spanner.admin.database.v1.Database], if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { RestoreDatabaseRequest request = RestoreDatabaseRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setDatabaseId("databaseId1688905718") .setEncryptionConfig(RestoreDatabaseEncryptionConfig.newBuilder().build()) .build(); Database response = databaseAdminClient.restoreDatabaseAsync(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
-
restoreDatabaseOperationCallable
public final com.google.api.gax.rpc.OperationCallable<RestoreDatabaseRequest,Database, restoreDatabaseOperationCallable()RestoreDatabaseMetadata> Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database [long-running operation][google.longrunning.Operation] has a name of the format `projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>`, and can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is [Database][google.spanner.admin.database.v1.Database], if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { RestoreDatabaseRequest request = RestoreDatabaseRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setDatabaseId("databaseId1688905718") .setEncryptionConfig(RestoreDatabaseEncryptionConfig.newBuilder().build()) .build(); OperationFuture<Database, RestoreDatabaseMetadata> future = databaseAdminClient.restoreDatabaseOperationCallable().futureCall(request); // Do something. Database response = future.get(); }
-
restoreDatabaseCallable
public final com.google.api.gax.rpc.UnaryCallable<RestoreDatabaseRequest,com.google.longrunning.Operation> restoreDatabaseCallable()Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database [long-running operation][google.longrunning.Operation] has a name of the format `projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>`, and can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is [Database][google.spanner.admin.database.v1.Database], if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { RestoreDatabaseRequest request = RestoreDatabaseRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setDatabaseId("databaseId1688905718") .setEncryptionConfig(RestoreDatabaseEncryptionConfig.newBuilder().build()) .build(); ApiFuture<Operation> future = databaseAdminClient.restoreDatabaseCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
listDatabaseOperations
public final DatabaseAdminClient.ListDatabaseOperationsPagedResponse listDatabaseOperations(InstanceName parent) Lists database [longrunning-operations][google.longrunning.Operation]. A database operation has a name of the form `projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`. The long-running operation [metadata][google.longrunning.Operation.metadata] field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]"); for (Operation element : databaseAdminClient.listDatabaseOperations(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The instance of the database operations. Values are of the form `projects/<project>/instances/<instance>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listDatabaseOperations
public final DatabaseAdminClient.ListDatabaseOperationsPagedResponse listDatabaseOperations(String parent) Lists database [longrunning-operations][google.longrunning.Operation]. A database operation has a name of the form `projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`. The long-running operation [metadata][google.longrunning.Operation.metadata] field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString(); for (Operation element : databaseAdminClient.listDatabaseOperations(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The instance of the database operations. Values are of the form `projects/<project>/instances/<instance>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listDatabaseOperations
public final DatabaseAdminClient.ListDatabaseOperationsPagedResponse listDatabaseOperations(ListDatabaseOperationsRequest request) Lists database [longrunning-operations][google.longrunning.Operation]. A database operation has a name of the form `projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`. The long-running operation [metadata][google.longrunning.Operation.metadata] field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { ListDatabaseOperationsRequest request = ListDatabaseOperationsRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (Operation element : databaseAdminClient.listDatabaseOperations(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
-
listDatabaseOperationsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListDatabaseOperationsRequest,DatabaseAdminClient.ListDatabaseOperationsPagedResponse> listDatabaseOperationsPagedCallable()Lists database [longrunning-operations][google.longrunning.Operation]. A database operation has a name of the form `projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`. The long-running operation [metadata][google.longrunning.Operation.metadata] field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { ListDatabaseOperationsRequest request = ListDatabaseOperationsRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<Operation> future = databaseAdminClient.listDatabaseOperationsPagedCallable().futureCall(request); // Do something. for (Operation element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listDatabaseOperationsCallable
public final com.google.api.gax.rpc.UnaryCallable<ListDatabaseOperationsRequest,ListDatabaseOperationsResponse> listDatabaseOperationsCallable()Lists database [longrunning-operations][google.longrunning.Operation]. A database operation has a name of the form `projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`. The long-running operation [metadata][google.longrunning.Operation.metadata] field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { ListDatabaseOperationsRequest request = ListDatabaseOperationsRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListDatabaseOperationsResponse response = databaseAdminClient.listDatabaseOperationsCallable().call(request); for (Operation element : response.getOperationsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
listBackupOperations
public final DatabaseAdminClient.ListBackupOperationsPagedResponse listBackupOperations(InstanceName parent) Lists the backup [long-running operations][google.longrunning.Operation] in the given instance. A backup operation has a name of the form `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>`. The long-running operation [metadata][google.longrunning.Operation.metadata] field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.progress.start_time` in descending order starting from the most recently started operation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]"); for (Operation element : databaseAdminClient.listBackupOperations(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The instance of the backup operations. Values are of the form `projects/<project>/instances/<instance>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listBackupOperations
public final DatabaseAdminClient.ListBackupOperationsPagedResponse listBackupOperations(String parent) Lists the backup [long-running operations][google.longrunning.Operation] in the given instance. A backup operation has a name of the form `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>`. The long-running operation [metadata][google.longrunning.Operation.metadata] field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.progress.start_time` in descending order starting from the most recently started operation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString(); for (Operation element : databaseAdminClient.listBackupOperations(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The instance of the backup operations. Values are of the form `projects/<project>/instances/<instance>`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listBackupOperations
public final DatabaseAdminClient.ListBackupOperationsPagedResponse listBackupOperations(ListBackupOperationsRequest request) Lists the backup [long-running operations][google.longrunning.Operation] in the given instance. A backup operation has a name of the form `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>`. The long-running operation [metadata][google.longrunning.Operation.metadata] field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.progress.start_time` in descending order starting from the most recently started operation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { ListBackupOperationsRequest request = ListBackupOperationsRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (Operation element : databaseAdminClient.listBackupOperations(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
-
listBackupOperationsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListBackupOperationsRequest,DatabaseAdminClient.ListBackupOperationsPagedResponse> listBackupOperationsPagedCallable()Lists the backup [long-running operations][google.longrunning.Operation] in the given instance. A backup operation has a name of the form `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>`. The long-running operation [metadata][google.longrunning.Operation.metadata] field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.progress.start_time` in descending order starting from the most recently started operation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { ListBackupOperationsRequest request = ListBackupOperationsRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<Operation> future = databaseAdminClient.listBackupOperationsPagedCallable().futureCall(request); // Do something. for (Operation element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listBackupOperationsCallable
public final com.google.api.gax.rpc.UnaryCallable<ListBackupOperationsRequest,ListBackupOperationsResponse> listBackupOperationsCallable()Lists the backup [long-running operations][google.longrunning.Operation] in the given instance. A backup operation has a name of the form `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>`. The long-running operation [metadata][google.longrunning.Operation.metadata] field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.progress.start_time` in descending order starting from the most recently started operation.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { ListBackupOperationsRequest request = ListBackupOperationsRequest.newBuilder() .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString()) .setFilter("filter-1274492040") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListBackupOperationsResponse response = databaseAdminClient.listBackupOperationsCallable().call(request); for (Operation element : response.getOperationsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
listDatabaseRoles
public final DatabaseAdminClient.ListDatabaseRolesPagedResponse listDatabaseRoles(DatabaseName parent) Lists Cloud Spanner database roles.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { DatabaseName parent = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]"); for (DatabaseRole element : databaseAdminClient.listDatabaseRoles(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The database whose roles should be listed. Values are of the form `projects/<project>/instances/<instance>/databases/<database>/databaseRoles`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listDatabaseRoles
Lists Cloud Spanner database roles.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { String parent = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString(); for (DatabaseRole element : databaseAdminClient.listDatabaseRoles(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The database whose roles should be listed. Values are of the form `projects/<project>/instances/<instance>/databases/<database>/databaseRoles`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listDatabaseRoles
public final DatabaseAdminClient.ListDatabaseRolesPagedResponse listDatabaseRoles(ListDatabaseRolesRequest request) Lists Cloud Spanner database roles.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { ListDatabaseRolesRequest request = ListDatabaseRolesRequest.newBuilder() .setParent(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (DatabaseRole element : databaseAdminClient.listDatabaseRoles(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
-
listDatabaseRolesPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListDatabaseRolesRequest,DatabaseAdminClient.ListDatabaseRolesPagedResponse> listDatabaseRolesPagedCallable()Lists Cloud Spanner database roles.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { ListDatabaseRolesRequest request = ListDatabaseRolesRequest.newBuilder() .setParent(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<DatabaseRole> future = databaseAdminClient.listDatabaseRolesPagedCallable().futureCall(request); // Do something. for (DatabaseRole element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listDatabaseRolesCallable
public final com.google.api.gax.rpc.UnaryCallable<ListDatabaseRolesRequest,ListDatabaseRolesResponse> listDatabaseRolesCallable()Lists Cloud Spanner database roles.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) { ListDatabaseRolesRequest request = ListDatabaseRolesRequest.newBuilder() .setParent(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListDatabaseRolesResponse response = databaseAdminClient.listDatabaseRolesCallable().call(request); for (DatabaseRole element : response.getDatabaseRolesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
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
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-