Classes
Backup
A backup of a Cloud Spanner database.
Backup.Types
Container for nested types declared in the Backup message type.
BackupInfo
Information about a backup.
BackupName
Resource name for the Backup resource.
CopyBackupEncryptionConfig
Encryption configuration for the copied backup.
CopyBackupEncryptionConfig.Types
Container for nested types declared in the CopyBackupEncryptionConfig message type.
CopyBackupMetadata
Metadata type for the google.longrunning.Operation returned by [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup].
CopyBackupRequest
The request for [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup].
CreateBackupEncryptionConfig
Encryption configuration for the backup to create.
CreateBackupEncryptionConfig.Types
Container for nested types declared in the CreateBackupEncryptionConfig message type.
CreateBackupMetadata
Metadata type for the operation returned by [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup].
CreateBackupRequest
The request for [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup].
CreateDatabaseMetadata
Metadata type for the operation returned by [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].
CreateDatabaseRequest
The request for [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].
CryptoKeyName
Resource name for the CryptoKey resource.
CryptoKeyVersionName
Resource name for the CryptoKeyVersion resource.
Database
A Cloud Spanner database.
Database.Types
Container for nested types declared in the Database message type.
DatabaseAdmin
Cloud Spanner Database Admin API
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
DatabaseAdmin.DatabaseAdminBase
Base class for server-side implementations of DatabaseAdmin
DatabaseAdmin.DatabaseAdminClient
Client for DatabaseAdmin
DatabaseAdminClient
DatabaseAdmin client wrapper, for convenient use.
DatabaseAdminClientBuilder
Builder class for DatabaseAdminClient to provide simple configuration of credentials, endpoint etc.
DatabaseAdminClientImpl
DatabaseAdmin client wrapper implementation, for convenient use.
DatabaseAdminSettings
Settings for DatabaseAdminClient instances.
DatabaseRole
A Cloud Spanner database role.
DatabaseRoleName
Resource name for the DatabaseRole resource.
DdlStatementActionInfo
Action information extracted from a DDL statement. This proto is used to display the brief info of the DDL statement for the operation [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl].
DeleteBackupRequest
The request for [DeleteBackup][google.spanner.admin.database.v1.DatabaseAdmin.DeleteBackup].
DropDatabaseRequest
The request for [DropDatabase][google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase].
EncryptionConfig
Encryption configuration for a Cloud Spanner database.
EncryptionInfo
Encryption information for a Cloud Spanner database or backup.
EncryptionInfo.Types
Container for nested types declared in the EncryptionInfo message type.
GetBackupRequest
The request for [GetBackup][google.spanner.admin.database.v1.DatabaseAdmin.GetBackup].
GetDatabaseDdlRequest
The request for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
GetDatabaseDdlResponse
The response for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
GetDatabaseRequest
The request for [GetDatabase][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase].
ListBackupOperationsRequest
The request for [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].
ListBackupOperationsResponse
The response for [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].
ListBackupsRequest
The request for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].
ListBackupsResponse
The response for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].
ListDatabaseOperationsRequest
The request for [ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations].
ListDatabaseOperationsResponse
The response for [ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations].
ListDatabaseRolesRequest
The request for [ListDatabaseRoles][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseRoles].
ListDatabaseRolesResponse
The response for [ListDatabaseRoles][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseRoles].
ListDatabasesRequest
The request for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
ListDatabasesResponse
The response for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
OperationProgress
Encapsulates progress related information for a Cloud Spanner long running operation.
OptimizeRestoredDatabaseMetadata
Metadata type for the long-running operation used to track the progress of optimizations performed on a newly restored database. This long-running operation is automatically created by the system after the successful completion of a database restore, and cannot be cancelled.
RestoreDatabaseEncryptionConfig
Encryption configuration for the restored database.
RestoreDatabaseEncryptionConfig.Types
Container for nested types declared in the RestoreDatabaseEncryptionConfig message type.
RestoreDatabaseMetadata
Metadata type for the long-running operation returned by [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].
RestoreDatabaseRequest
The request for [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].
RestoreInfo
Information about the database restore.
UpdateBackupRequest
The request for [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup].
UpdateDatabaseDdlMetadata
Metadata type for the operation returned by [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl].
UpdateDatabaseDdlRequest
Enqueues the given DDL statements to be applied, in order but not
necessarily all at once, to the database schema at some point (or
points) in the future. The server checks that the statements
are executable (syntactically valid, name tables that exist, etc.)
before enqueueing them, but they may still fail upon
later execution (e.g., if a statement from another batch of
statements is applied first and it conflicts in some way, or if
there is some data-related problem like a NULL value in a column to
which NOT NULL would be added). If a statement fails, all
subsequent statements in the batch are automatically cancelled.
Each batch of statements is assigned a name which can be used with the [Operations][google.longrunning.Operations] API to monitor progress. See the [operation_id][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.operation_id] field for more details.
UpdateDatabaseMetadata
Metadata type for the operation returned by [UpdateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabase].
UpdateDatabaseRequest
The request for [UpdateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabase].
Enums
Backup.Types.State
Indicates the current state of the backup.
BackupName.ResourceNameType
The possible contents of BackupName.
CopyBackupEncryptionConfig.Types.EncryptionType
Encryption types for the backup.
CreateBackupEncryptionConfig.Types.EncryptionType
Encryption types for the backup.
CryptoKeyName.ResourceNameType
The possible contents of CryptoKeyName.
CryptoKeyVersionName.ResourceNameType
The possible contents of CryptoKeyVersionName.
Database.Types.State
Indicates the current state of the database.
DatabaseDialect
Indicates the dialect type of a database.
DatabaseRoleName.ResourceNameType
The possible contents of DatabaseRoleName.
EncryptionInfo.Types.Type
Possible encryption types.
RestoreDatabaseEncryptionConfig.Types.EncryptionType
Encryption types for the database to be restored.
RestoreDatabaseMetadata.SourceInfoOneofCase
Enum of possible cases for the "source_info" oneof.
RestoreDatabaseRequest.SourceOneofCase
Enum of possible cases for the "source" oneof.
RestoreInfo.SourceInfoOneofCase
Enum of possible cases for the "source_info" oneof.
RestoreSourceType
Indicates the type of the restore source.