Interface DatabaseAdminClient (2.16.1)

public interface DatabaseAdminClient

Methods

cancelOperation(String arg0)

public abstract void cancelOperation(String arg0)

Parameter
Name	Description
`arg0`	`String`

copyBackup(BackupId arg0, Backup arg1)

public default OperationFuture<Backup,CopyBackupMetadata> copyBackup(BackupId arg0, Backup arg1)

Parameters
Name	Description
`arg0`	`BackupId`
`arg1`	`Backup`

Returns
Type	Description
`OperationFuture<Backup,com.google.spanner.admin.database.v1.CopyBackupMetadata>`

copyBackup(String arg0, String arg1, String arg2, Timestamp arg3)

public default OperationFuture<Backup,CopyBackupMetadata> copyBackup(String arg0, String arg1, String arg2, Timestamp arg3)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`
`arg2`	`String`
`arg3`	`com.google.cloud.Timestamp`

Returns
Type	Description
`OperationFuture<Backup,com.google.spanner.admin.database.v1.CopyBackupMetadata>`

createBackup(Backup arg0)

public abstract OperationFuture<Backup,CreateBackupMetadata> createBackup(Backup arg0)

Parameter
Name	Description
`arg0`	`Backup`

Returns
Type	Description
`OperationFuture<Backup,com.google.spanner.admin.database.v1.CreateBackupMetadata>`

Exceptions
Type	Description
`SpannerException`

createBackup(String arg0, String arg1, String arg2, Timestamp arg3)

public abstract OperationFuture<Backup,CreateBackupMetadata> createBackup(String arg0, String arg1, String arg2, Timestamp arg3)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`
`arg2`	`String`
`arg3`	`com.google.cloud.Timestamp`

Returns
Type	Description
`OperationFuture<Backup,com.google.spanner.admin.database.v1.CreateBackupMetadata>`

Exceptions
Type	Description
`SpannerException`

createDatabase(Database arg0, Iterable<String> arg1)

public abstract OperationFuture<Database,CreateDatabaseMetadata> createDatabase(Database arg0, Iterable<String> arg1)

Parameters
Name	Description
`arg0`	`Database`
`arg1`	`Iterable<String>`

Returns
Type	Description
`OperationFuture<Database,com.google.spanner.admin.database.v1.CreateDatabaseMetadata>`

Exceptions
Type	Description
`SpannerException`

createDatabase(String arg0, String arg1, Dialect arg2, Iterable<String> arg3)

public default OperationFuture<Database,CreateDatabaseMetadata> createDatabase(String arg0, String arg1, Dialect arg2, Iterable<String> arg3)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`
`arg2`	`Dialect`
`arg3`	`Iterable<String>`

Returns
Type	Description
`OperationFuture<Database,com.google.spanner.admin.database.v1.CreateDatabaseMetadata>`

Exceptions
Type	Description
`SpannerException`

createDatabase(String arg0, String arg1, Iterable<String> arg2)

public abstract OperationFuture<Database,CreateDatabaseMetadata> createDatabase(String arg0, String arg1, Iterable<String> arg2)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`
`arg2`	`Iterable<String>`

Returns
Type	Description
`OperationFuture<Database,com.google.spanner.admin.database.v1.CreateDatabaseMetadata>`

Exceptions
Type	Description
`SpannerException`

deleteBackup(String arg0, String arg1)

public abstract void deleteBackup(String arg0, String arg1)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`

dropDatabase(String arg0, String arg1)

public abstract void dropDatabase(String arg0, String arg1)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`

Exceptions
Type	Description
`SpannerException`

getBackup(String arg0, String arg1)

public abstract Backup getBackup(String arg0, String arg1)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`

Returns
Type	Description
`Backup`

Exceptions
Type	Description
`SpannerException`

getBackupIAMPolicy(String arg0, String arg1)

public abstract Policy getBackupIAMPolicy(String arg0, String arg1)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`

Returns
Type	Description
`com.google.cloud.Policy`

getDatabase(String arg0, String arg1)

public abstract Database getDatabase(String arg0, String arg1)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`

Returns
Type	Description
`Database`

Exceptions
Type	Description
`SpannerException`

getDatabaseDdl(String arg0, String arg1)

public abstract List<String> getDatabaseDdl(String arg0, String arg1)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`

Returns
Type	Description
`List<String>`

getDatabaseDdlResponse(String arg0, String arg1)

public abstract GetDatabaseDdlResponse getDatabaseDdlResponse(String arg0, String arg1)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`

Returns
Type	Description
`com.google.spanner.admin.database.v1.GetDatabaseDdlResponse`

getDatabaseIAMPolicy(String arg0, String arg1, int arg2)

public abstract Policy getDatabaseIAMPolicy(String arg0, String arg1, int arg2)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`
`arg2`	`int`

Returns
Type	Description
`com.google.cloud.Policy`

getOperation(String arg0)

public abstract Operation getOperation(String arg0)

Parameter
Name	Description
`arg0`	`String`

Returns
Type	Description
`Operation`

listBackupOperations(String arg0, Options.ListOption[] arg1)

public abstract Page<Operation> listBackupOperations(String arg0, Options.ListOption[] arg1)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`ListOption[]`

Returns
Type	Description
`Page<Operation>`

listBackups(String arg0, Options.ListOption[] arg1)

public abstract Page<Backup> listBackups(String arg0, Options.ListOption[] arg1)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`ListOption[]`

Returns
Type	Description
`Page<Backup>`

listDatabaseOperations(String arg0, Options.ListOption[] arg1)

public abstract Page<Operation> listDatabaseOperations(String arg0, Options.ListOption[] arg1)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`ListOption[]`

Returns
Type	Description
`Page<Operation>`

listDatabaseRoles(String arg0, String arg1, Options.ListOption[] arg2)

public abstract Page<DatabaseRole> listDatabaseRoles(String arg0, String arg1, Options.ListOption[] arg2)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`
`arg2`	`ListOption[]`

Returns
Type	Description
`Page<DatabaseRole>`

listDatabases(String arg0, Options.ListOption[] arg1)

public abstract Page<Database> listDatabases(String arg0, Options.ListOption[] arg1)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`ListOption[]`

Returns
Type	Description
`Page<Database>`

newBackupBuilder(BackupId arg0)

public abstract Backup.Builder newBackupBuilder(BackupId arg0)

Parameter
Name	Description
`arg0`	`BackupId`

Returns
Type	Description
`Builder`

newDatabaseBuilder(DatabaseId arg0)

public abstract Database.Builder newDatabaseBuilder(DatabaseId arg0)

Parameter
Name	Description
`arg0`	`DatabaseId`

Returns
Type	Description
`Builder`

newRestoreBuilder(BackupId arg0, DatabaseId arg1)

public abstract Restore.Builder newRestoreBuilder(BackupId arg0, DatabaseId arg1)

Parameters
Name	Description
`arg0`	`BackupId`
`arg1`	`DatabaseId`

Returns
Type	Description
`Builder`

restoreDatabase(Restore arg0)

public abstract OperationFuture<Database,RestoreDatabaseMetadata> restoreDatabase(Restore arg0)

Parameter
Name	Description
`arg0`	`Restore`

Returns
Type	Description
`OperationFuture<Database,com.google.spanner.admin.database.v1.RestoreDatabaseMetadata>`

Exceptions
Type	Description
`SpannerException`

restoreDatabase(String arg0, String arg1, String arg2, String arg3)

public abstract OperationFuture<Database,RestoreDatabaseMetadata> restoreDatabase(String arg0, String arg1, String arg2, String arg3)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`
`arg2`	`String`
`arg3`	`String`

Returns
Type	Description
`OperationFuture<Database,com.google.spanner.admin.database.v1.RestoreDatabaseMetadata>`

Exceptions
Type	Description
`SpannerException`

setBackupIAMPolicy(String arg0, String arg1, Policy arg2)

public abstract Policy setBackupIAMPolicy(String arg0, String arg1, Policy arg2)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`
`arg2`	`com.google.cloud.Policy`

Returns
Type	Description
`com.google.cloud.Policy`

setDatabaseIAMPolicy(String arg0, String arg1, Policy arg2)

public abstract Policy setDatabaseIAMPolicy(String arg0, String arg1, Policy arg2)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`
`arg2`	`com.google.cloud.Policy`

Returns
Type	Description
`com.google.cloud.Policy`

testBackupIAMPermissions(String arg0, String arg1, Iterable<String> arg2)

public abstract Iterable<String> testBackupIAMPermissions(String arg0, String arg1, Iterable<String> arg2)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`
`arg2`	`Iterable<String>`

Returns
Type	Description
`Iterable<String>`

testDatabaseIAMPermissions(String arg0, String arg1, Iterable<String> arg2)

public abstract Iterable<String> testDatabaseIAMPermissions(String arg0, String arg1, Iterable<String> arg2)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`
`arg2`	`Iterable<String>`

Returns
Type	Description
`Iterable<String>`

updateBackup(String arg0, String arg1, Timestamp arg2)

public abstract Backup updateBackup(String arg0, String arg1, Timestamp arg2)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`
`arg2`	`com.google.cloud.Timestamp`

Returns
Type	Description
`Backup`

updateDatabase(Database arg0, DatabaseInfo.DatabaseField[] arg1)

public abstract OperationFuture<Database,UpdateDatabaseMetadata> updateDatabase(Database arg0, DatabaseInfo.DatabaseField[] arg1)

Parameters
Name	Description
`arg0`	`Database`
`arg1`	`DatabaseField[]`

Returns
Type	Description
`OperationFuture<Database,com.google.spanner.admin.database.v1.UpdateDatabaseMetadata>`

Exceptions
Type	Description
`SpannerException`

updateDatabaseDdl(Database arg0, Iterable<String> arg1, String arg2)

public abstract OperationFuture<Void,UpdateDatabaseDdlMetadata> updateDatabaseDdl(Database arg0, Iterable<String> arg1, String arg2)

Parameters
Name	Description
`arg0`	`Database`
`arg1`	`Iterable<String>`
`arg2`	`String`

Returns
Type	Description
`OperationFuture<Void,com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata>`

Exceptions
Type	Description
`SpannerException`

updateDatabaseDdl(String arg0, String arg1, Iterable<String> arg2, String arg3)

public abstract OperationFuture<Void,UpdateDatabaseDdlMetadata> updateDatabaseDdl(String arg0, String arg1, Iterable<String> arg2, String arg3)

Parameters
Name	Description
`arg0`	`String`
`arg1`	`String`
`arg2`	`Iterable<String>`
`arg3`	`String`

Returns
Type	Description
`OperationFuture<Void,com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata>`

Exceptions
Type	Description
`SpannerException`