DatabaseAdminClient (Google Cloud 0.90.0-alpha API)

java.lang.Object
- com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class DatabaseAdminClient
extends Object
implements BackgroundResource
```
Service Description: Cloud Spanner Database Admin API
The Cloud Spanner Database Admin API can be used to create, drop, and list databases. It also enables updating the schema of pre-existing databases.
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:
```
 
 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:
1. 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.
2. 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.
3. 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:
```
 
 DatabaseAdminSettings databaseAdminSettings =
     DatabaseAdminSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DatabaseAdminClient databaseAdminClient =
     DatabaseAdminClient.create(databaseAdminSettings);
 
 
```
To customize the endpoint:
```
 
 DatabaseAdminSettings databaseAdminSettings =
     DatabaseAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
 DatabaseAdminClient databaseAdminClient =
     DatabaseAdminClient.create(databaseAdminSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DatabaseAdminClient.ListDatabasesFixedSizeCollection`
`static class`	`DatabaseAdminClient.ListDatabasesPage`
`static class`	`DatabaseAdminClient.ListDatabasesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DatabaseAdminClient(DatabaseAdminSettings settings)` Constructs an instance of DatabaseAdminClient, using the given settings.
`protected`	`DatabaseAdminClient(DatabaseAdminStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static DatabaseAdminClient`	`create()` Constructs an instance of DatabaseAdminClient with default settings.
`static DatabaseAdminClient`	`create(DatabaseAdminSettings settings)` Constructs an instance of DatabaseAdminClient, using the given settings.
`static DatabaseAdminClient`	`create(DatabaseAdminStub stub)` Constructs an instance of DatabaseAdminClient, using the given stub for making calls.
`OperationFuture<com.google.spanner.admin.database.v1.Database,com.google.spanner.admin.database.v1.CreateDatabaseMetadata>`	`createDatabaseAsync(com.google.spanner.admin.database.v1.CreateDatabaseRequest request)` Creates a new Cloud Spanner database and starts to prepare it for serving.
`OperationFuture<com.google.spanner.admin.database.v1.Database,com.google.spanner.admin.database.v1.CreateDatabaseMetadata>`	`createDatabaseAsync(com.google.spanner.admin.database.v1.InstanceName parent, String createStatement)` Creates a new Cloud Spanner database and starts to prepare it for serving.
`OperationFuture<com.google.spanner.admin.database.v1.Database,com.google.spanner.admin.database.v1.CreateDatabaseMetadata>`	`createDatabaseAsync(String parent, String createStatement)` Creates a new Cloud Spanner database and starts to prepare it for serving.
`UnaryCallable<com.google.spanner.admin.database.v1.CreateDatabaseRequest,Operation>`	`createDatabaseCallable()` Creates a new Cloud Spanner database and starts to prepare it for serving.
`OperationCallable<com.google.spanner.admin.database.v1.CreateDatabaseRequest,com.google.spanner.admin.database.v1.Database,com.google.spanner.admin.database.v1.CreateDatabaseMetadata>`	`createDatabaseOperationCallable()` Creates a new Cloud Spanner database and starts to prepare it for serving.
`void`	`dropDatabase(com.google.spanner.admin.database.v1.DatabaseName database)` Drops (aka deletes) a Cloud Spanner database.
`void`	`dropDatabase(com.google.spanner.admin.database.v1.DropDatabaseRequest request)` Drops (aka deletes) a Cloud Spanner database.
`void`	`dropDatabase(String database)` Drops (aka deletes) a Cloud Spanner database.
`UnaryCallable<com.google.spanner.admin.database.v1.DropDatabaseRequest,Empty>`	`dropDatabaseCallable()` Drops (aka deletes) a Cloud Spanner database.
`com.google.spanner.admin.database.v1.Database`	`getDatabase(com.google.spanner.admin.database.v1.DatabaseName name)` Gets the state of a Cloud Spanner database.
`com.google.spanner.admin.database.v1.Database`	`getDatabase(com.google.spanner.admin.database.v1.GetDatabaseRequest request)` Gets the state of a Cloud Spanner database.
`com.google.spanner.admin.database.v1.Database`	`getDatabase(String name)` Gets the state of a Cloud Spanner database.
`UnaryCallable<com.google.spanner.admin.database.v1.GetDatabaseRequest,com.google.spanner.admin.database.v1.Database>`	`getDatabaseCallable()` Gets the state of a Cloud Spanner database.
`com.google.spanner.admin.database.v1.GetDatabaseDdlResponse`	`getDatabaseDdl(com.google.spanner.admin.database.v1.DatabaseName database)` Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.
`com.google.spanner.admin.database.v1.GetDatabaseDdlResponse`	`getDatabaseDdl(com.google.spanner.admin.database.v1.GetDatabaseDdlRequest request)` Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.
`com.google.spanner.admin.database.v1.GetDatabaseDdlResponse`	`getDatabaseDdl(String database)` Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.
`UnaryCallable<com.google.spanner.admin.database.v1.GetDatabaseDdlRequest,com.google.spanner.admin.database.v1.GetDatabaseDdlResponse>`	`getDatabaseDdlCallable()` Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)` Gets the access control policy for a database resource.
`com.google.iam.v1.Policy`	`getIamPolicy(String resource)` Gets the access control policy for a database resource.
`UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the access control policy for a database resource.
`OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`DatabaseAdminSettings`	`getSettings()`
`DatabaseAdminStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`DatabaseAdminClient.ListDatabasesPagedResponse`	`listDatabases(com.google.spanner.admin.database.v1.InstanceName parent)` Lists Cloud Spanner databases.
`DatabaseAdminClient.ListDatabasesPagedResponse`	`listDatabases(com.google.spanner.admin.database.v1.ListDatabasesRequest request)` Lists Cloud Spanner databases.
`DatabaseAdminClient.ListDatabasesPagedResponse`	`listDatabases(String parent)` Lists Cloud Spanner databases.
`UnaryCallable<com.google.spanner.admin.database.v1.ListDatabasesRequest,com.google.spanner.admin.database.v1.ListDatabasesResponse>`	`listDatabasesCallable()` Lists Cloud Spanner databases.
`UnaryCallable<com.google.spanner.admin.database.v1.ListDatabasesRequest,DatabaseAdminClient.ListDatabasesPagedResponse>`	`listDatabasesPagedCallable()` Lists Cloud Spanner databases.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Sets the access control policy on a database resource.
`com.google.iam.v1.Policy`	`setIamPolicy(String resource, com.google.iam.v1.Policy policy)` Sets the access control policy on a database resource.
`UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`	`setIamPolicyCallable()` Sets the access control policy on a database resource.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(String resource, List<String> permissions)` Returns permissions that the caller has on the specified database resource.
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)` Returns permissions that the caller has on the specified database resource.
`UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns permissions that the caller has on the specified database resource.
`OperationFuture<Empty,com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata>`	`updateDatabaseDdlAsync(com.google.spanner.admin.database.v1.DatabaseName database, List<String> statements)` Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.
`OperationFuture<Empty,com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata>`	`updateDatabaseDdlAsync(String database, List<String> statements)` Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.
`OperationFuture<Empty,com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata>`	`updateDatabaseDdlAsync(com.google.spanner.admin.database.v1.UpdateDatabaseDdlRequest request)` Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.
`UnaryCallable<com.google.spanner.admin.database.v1.UpdateDatabaseDdlRequest,Operation>`	`updateDatabaseDdlCallable()` Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.
`OperationCallable<com.google.spanner.admin.database.v1.UpdateDatabaseDdlRequest,Empty,com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata>`	`updateDatabaseDdlOperationCallable()` Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- DatabaseAdminClient
```
protected DatabaseAdminClient(DatabaseAdminSettings settings)
                       throws IOException
```
  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
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected DatabaseAdminClient(DatabaseAdminStub stub)
```

Method Detail

create

public static final DatabaseAdminClient create()
                                        throws IOException

Constructs an instance of DatabaseAdminClient with default settings.

Throws:: IOException

create
```
public static final DatabaseAdminClient create(DatabaseAdminSettings settings)
                                        throws IOException
```
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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final DatabaseAdminClient create(DatabaseAdminStub stub)

Constructs an instance of DatabaseAdminClient, using the given stub for making calls. This is for advanced usage - prefer to use DatabaseAdminSettings}.

getSettings

public final DatabaseAdminSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public DatabaseAdminStub getStub()

getOperationsClient

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationsClient getOperationsClient()

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