Classes
Backup
A backup of a Cloud Spanner database.
Protobuf type google.spanner.admin.database.v1.Backup
Backup.Builder
A backup of a Cloud Spanner database.
Protobuf type google.spanner.admin.database.v1.Backup
BackupInfo
Information about a backup.
Protobuf type google.spanner.admin.database.v1.BackupInfo
BackupInfo.Builder
Information about a backup.
Protobuf type google.spanner.admin.database.v1.BackupInfo
BackupName
BackupName.Builder
Builder for projects/{project}/instances/{instance}/backups/{backup}.
BackupProto
CommonProto
CopyBackupEncryptionConfig
Encryption configuration for the copied backup.
Protobuf type google.spanner.admin.database.v1.CopyBackupEncryptionConfig
CopyBackupEncryptionConfig.Builder
Encryption configuration for the copied backup.
Protobuf type google.spanner.admin.database.v1.CopyBackupEncryptionConfig
CopyBackupMetadata
Metadata type for the google.longrunning.Operation returned by CopyBackup.
Protobuf type google.spanner.admin.database.v1.CopyBackupMetadata
CopyBackupMetadata.Builder
Metadata type for the google.longrunning.Operation returned by CopyBackup.
Protobuf type google.spanner.admin.database.v1.CopyBackupMetadata
CopyBackupRequest
The request for CopyBackup.
Protobuf type google.spanner.admin.database.v1.CopyBackupRequest
CopyBackupRequest.Builder
The request for CopyBackup.
Protobuf type google.spanner.admin.database.v1.CopyBackupRequest
CreateBackupEncryptionConfig
Encryption configuration for the backup to create.
Protobuf type google.spanner.admin.database.v1.CreateBackupEncryptionConfig
CreateBackupEncryptionConfig.Builder
Encryption configuration for the backup to create.
Protobuf type google.spanner.admin.database.v1.CreateBackupEncryptionConfig
CreateBackupMetadata
Metadata type for the operation returned by CreateBackup.
Protobuf type google.spanner.admin.database.v1.CreateBackupMetadata
CreateBackupMetadata.Builder
Metadata type for the operation returned by CreateBackup.
Protobuf type google.spanner.admin.database.v1.CreateBackupMetadata
CreateBackupRequest
The request for CreateBackup.
Protobuf type google.spanner.admin.database.v1.CreateBackupRequest
CreateBackupRequest.Builder
The request for CreateBackup.
Protobuf type google.spanner.admin.database.v1.CreateBackupRequest
CreateDatabaseMetadata
Metadata type for the operation returned by CreateDatabase.
Protobuf type google.spanner.admin.database.v1.CreateDatabaseMetadata
CreateDatabaseMetadata.Builder
Metadata type for the operation returned by CreateDatabase.
Protobuf type google.spanner.admin.database.v1.CreateDatabaseMetadata
CreateDatabaseRequest
The request for CreateDatabase.
Protobuf type google.spanner.admin.database.v1.CreateDatabaseRequest
CreateDatabaseRequest.Builder
The request for CreateDatabase.
Protobuf type google.spanner.admin.database.v1.CreateDatabaseRequest
CryptoKeyName
CryptoKeyName.Builder
Builder for projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
CryptoKeyVersionName
CryptoKeyVersionName.Builder
Builder for projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.
Database
A Cloud Spanner database.
Protobuf type google.spanner.admin.database.v1.Database
Database.Builder
A Cloud Spanner database.
Protobuf type google.spanner.admin.database.v1.Database
DatabaseAdminGrpc
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
DatabaseAdminGrpc.DatabaseAdminBlockingStub
A stub to allow clients to do synchronous rpc calls to service 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
DatabaseAdminGrpc.DatabaseAdminFutureStub
A stub to allow clients to do ListenableFuture-style rpc calls to service 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
DatabaseAdminGrpc.DatabaseAdminImplBase
Base class for the server implementation of the service 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
DatabaseAdminGrpc.DatabaseAdminStub
A stub to allow clients to do asynchronous rpc calls to service 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
DatabaseName
DatabaseName.Builder
Builder for projects/{project}/instances/{instance}/databases/{database}.
DatabaseRole
A Cloud Spanner database role.
Protobuf type google.spanner.admin.database.v1.DatabaseRole
DatabaseRole.Builder
A Cloud Spanner database role.
Protobuf type google.spanner.admin.database.v1.DatabaseRole
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.
Protobuf type google.spanner.admin.database.v1.DdlStatementActionInfo
DdlStatementActionInfo.Builder
Action information extracted from a DDL statement. This proto is used to display the brief info of the DDL statement for the operation UpdateDatabaseDdl.
Protobuf type google.spanner.admin.database.v1.DdlStatementActionInfo
DeleteBackupRequest
The request for DeleteBackup.
Protobuf type google.spanner.admin.database.v1.DeleteBackupRequest
DeleteBackupRequest.Builder
The request for DeleteBackup.
Protobuf type google.spanner.admin.database.v1.DeleteBackupRequest
DropDatabaseRequest
The request for DropDatabase.
Protobuf type google.spanner.admin.database.v1.DropDatabaseRequest
DropDatabaseRequest.Builder
The request for DropDatabase.
Protobuf type google.spanner.admin.database.v1.DropDatabaseRequest
EncryptionConfig
Encryption configuration for a Cloud Spanner database.
Protobuf type google.spanner.admin.database.v1.EncryptionConfig
EncryptionConfig.Builder
Encryption configuration for a Cloud Spanner database.
Protobuf type google.spanner.admin.database.v1.EncryptionConfig
EncryptionInfo
Encryption information for a Cloud Spanner database or backup.
Protobuf type google.spanner.admin.database.v1.EncryptionInfo
EncryptionInfo.Builder
Encryption information for a Cloud Spanner database or backup.
Protobuf type google.spanner.admin.database.v1.EncryptionInfo
GetBackupRequest
The request for GetBackup.
Protobuf type google.spanner.admin.database.v1.GetBackupRequest
GetBackupRequest.Builder
The request for GetBackup.
Protobuf type google.spanner.admin.database.v1.GetBackupRequest
GetDatabaseDdlRequest
The request for GetDatabaseDdl.
Protobuf type google.spanner.admin.database.v1.GetDatabaseDdlRequest
GetDatabaseDdlRequest.Builder
The request for GetDatabaseDdl.
Protobuf type google.spanner.admin.database.v1.GetDatabaseDdlRequest
GetDatabaseDdlResponse
The response for GetDatabaseDdl.
Protobuf type google.spanner.admin.database.v1.GetDatabaseDdlResponse
GetDatabaseDdlResponse.Builder
The response for GetDatabaseDdl.
Protobuf type google.spanner.admin.database.v1.GetDatabaseDdlResponse
GetDatabaseRequest
The request for GetDatabase.
Protobuf type google.spanner.admin.database.v1.GetDatabaseRequest
GetDatabaseRequest.Builder
The request for GetDatabase.
Protobuf type google.spanner.admin.database.v1.GetDatabaseRequest
InstanceName
InstanceName.Builder
Builder for projects/{project}/instances/{instance}.
ListBackupOperationsRequest
The request for ListBackupOperations.
Protobuf type google.spanner.admin.database.v1.ListBackupOperationsRequest
ListBackupOperationsRequest.Builder
The request for ListBackupOperations.
Protobuf type google.spanner.admin.database.v1.ListBackupOperationsRequest
ListBackupOperationsResponse
The response for ListBackupOperations.
Protobuf type google.spanner.admin.database.v1.ListBackupOperationsResponse
ListBackupOperationsResponse.Builder
The response for ListBackupOperations.
Protobuf type google.spanner.admin.database.v1.ListBackupOperationsResponse
ListBackupsRequest
The request for ListBackups.
Protobuf type google.spanner.admin.database.v1.ListBackupsRequest
ListBackupsRequest.Builder
The request for ListBackups.
Protobuf type google.spanner.admin.database.v1.ListBackupsRequest
ListBackupsResponse
The response for ListBackups.
Protobuf type google.spanner.admin.database.v1.ListBackupsResponse
ListBackupsResponse.Builder
The response for ListBackups.
Protobuf type google.spanner.admin.database.v1.ListBackupsResponse
ListDatabaseOperationsRequest
The request for ListDatabaseOperations.
Protobuf type google.spanner.admin.database.v1.ListDatabaseOperationsRequest
ListDatabaseOperationsRequest.Builder
The request for ListDatabaseOperations.
Protobuf type google.spanner.admin.database.v1.ListDatabaseOperationsRequest
ListDatabaseOperationsResponse
The response for ListDatabaseOperations.
Protobuf type google.spanner.admin.database.v1.ListDatabaseOperationsResponse
ListDatabaseOperationsResponse.Builder
The response for ListDatabaseOperations.
Protobuf type google.spanner.admin.database.v1.ListDatabaseOperationsResponse
ListDatabaseRolesRequest
The request for ListDatabaseRoles.
Protobuf type google.spanner.admin.database.v1.ListDatabaseRolesRequest
ListDatabaseRolesRequest.Builder
The request for ListDatabaseRoles.
Protobuf type google.spanner.admin.database.v1.ListDatabaseRolesRequest
ListDatabaseRolesResponse
The response for ListDatabaseRoles.
Protobuf type google.spanner.admin.database.v1.ListDatabaseRolesResponse
ListDatabaseRolesResponse.Builder
The response for ListDatabaseRoles.
Protobuf type google.spanner.admin.database.v1.ListDatabaseRolesResponse
ListDatabasesRequest
The request for ListDatabases.
Protobuf type google.spanner.admin.database.v1.ListDatabasesRequest
ListDatabasesRequest.Builder
The request for ListDatabases.
Protobuf type google.spanner.admin.database.v1.ListDatabasesRequest
ListDatabasesResponse
The response for ListDatabases.
Protobuf type google.spanner.admin.database.v1.ListDatabasesResponse
ListDatabasesResponse.Builder
The response for ListDatabases.
Protobuf type google.spanner.admin.database.v1.ListDatabasesResponse
OperationProgress
Encapsulates progress related information for a Cloud Spanner long running operation.
Protobuf type google.spanner.admin.database.v1.OperationProgress
OperationProgress.Builder
Encapsulates progress related information for a Cloud Spanner long running operation.
Protobuf type google.spanner.admin.database.v1.OperationProgress
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.
Protobuf type google.spanner.admin.database.v1.OptimizeRestoredDatabaseMetadata
OptimizeRestoredDatabaseMetadata.Builder
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.
Protobuf type google.spanner.admin.database.v1.OptimizeRestoredDatabaseMetadata
RestoreDatabaseEncryptionConfig
Encryption configuration for the restored database.
Protobuf type google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig
RestoreDatabaseEncryptionConfig.Builder
Encryption configuration for the restored database.
Protobuf type google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig
RestoreDatabaseMetadata
Metadata type for the long-running operation returned by RestoreDatabase.
Protobuf type google.spanner.admin.database.v1.RestoreDatabaseMetadata
RestoreDatabaseMetadata.Builder
Metadata type for the long-running operation returned by RestoreDatabase.
Protobuf type google.spanner.admin.database.v1.RestoreDatabaseMetadata
RestoreDatabaseRequest
The request for RestoreDatabase.
Protobuf type google.spanner.admin.database.v1.RestoreDatabaseRequest
RestoreDatabaseRequest.Builder
The request for RestoreDatabase.
Protobuf type google.spanner.admin.database.v1.RestoreDatabaseRequest
RestoreInfo
Information about the database restore.
Protobuf type google.spanner.admin.database.v1.RestoreInfo
RestoreInfo.Builder
Information about the database restore.
Protobuf type google.spanner.admin.database.v1.RestoreInfo
SpannerDatabaseAdminProto
UpdateBackupRequest
The request for UpdateBackup.
Protobuf type google.spanner.admin.database.v1.UpdateBackupRequest
UpdateBackupRequest.Builder
The request for UpdateBackup.
Protobuf type google.spanner.admin.database.v1.UpdateBackupRequest
UpdateDatabaseDdlMetadata
Metadata type for the operation returned by UpdateDatabaseDdl.
Protobuf type google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata
UpdateDatabaseDdlMetadata.Builder
Metadata type for the operation returned by UpdateDatabaseDdl.
Protobuf type google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata
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 API to monitor progress. See the operation_id field for more details.
Protobuf type google.spanner.admin.database.v1.UpdateDatabaseDdlRequest
UpdateDatabaseDdlRequest.Builder
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 API to monitor progress. See the operation_id field for more details.
Protobuf type google.spanner.admin.database.v1.UpdateDatabaseDdlRequest
UpdateDatabaseMetadata
Metadata type for the operation returned by UpdateDatabase.
Protobuf type google.spanner.admin.database.v1.UpdateDatabaseMetadata
UpdateDatabaseMetadata.Builder
Metadata type for the operation returned by UpdateDatabase.
Protobuf type google.spanner.admin.database.v1.UpdateDatabaseMetadata
UpdateDatabaseRequest
The request for UpdateDatabase.
Protobuf type google.spanner.admin.database.v1.UpdateDatabaseRequest
UpdateDatabaseRequest.Builder
The request for UpdateDatabase.
Protobuf type google.spanner.admin.database.v1.UpdateDatabaseRequest
Interfaces
BackupInfoOrBuilder
BackupOrBuilder
CopyBackupEncryptionConfigOrBuilder
CopyBackupMetadataOrBuilder
CopyBackupRequestOrBuilder
CreateBackupEncryptionConfigOrBuilder
CreateBackupMetadataOrBuilder
CreateBackupRequestOrBuilder
CreateDatabaseMetadataOrBuilder
CreateDatabaseRequestOrBuilder
DatabaseAdminGrpc.AsyncService
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
DatabaseOrBuilder
DatabaseRoleOrBuilder
DdlStatementActionInfoOrBuilder
DeleteBackupRequestOrBuilder
DropDatabaseRequestOrBuilder
EncryptionConfigOrBuilder
EncryptionInfoOrBuilder
GetBackupRequestOrBuilder
GetDatabaseDdlRequestOrBuilder
GetDatabaseDdlResponseOrBuilder
GetDatabaseRequestOrBuilder
ListBackupOperationsRequestOrBuilder
ListBackupOperationsResponseOrBuilder
ListBackupsRequestOrBuilder
ListBackupsResponseOrBuilder
ListDatabaseOperationsRequestOrBuilder
ListDatabaseOperationsResponseOrBuilder
ListDatabaseRolesRequestOrBuilder
ListDatabaseRolesResponseOrBuilder
ListDatabasesRequestOrBuilder
ListDatabasesResponseOrBuilder
OperationProgressOrBuilder
OptimizeRestoredDatabaseMetadataOrBuilder
RestoreDatabaseEncryptionConfigOrBuilder
RestoreDatabaseMetadataOrBuilder
RestoreDatabaseRequestOrBuilder
RestoreInfoOrBuilder
UpdateBackupRequestOrBuilder
UpdateDatabaseDdlMetadataOrBuilder
UpdateDatabaseDdlRequestOrBuilder
UpdateDatabaseMetadataOrBuilder
UpdateDatabaseRequestOrBuilder
Enums
Backup.State
Indicates the current state of the backup.
Protobuf enum google.spanner.admin.database.v1.Backup.State
CopyBackupEncryptionConfig.EncryptionType
Encryption types for the backup.
Protobuf enum
google.spanner.admin.database.v1.CopyBackupEncryptionConfig.EncryptionType
CreateBackupEncryptionConfig.EncryptionType
Encryption types for the backup.
Protobuf enum
google.spanner.admin.database.v1.CreateBackupEncryptionConfig.EncryptionType
Database.State
Indicates the current state of the database.
Protobuf enum google.spanner.admin.database.v1.Database.State
DatabaseDialect
Indicates the dialect type of a database.
Protobuf enum google.spanner.admin.database.v1.DatabaseDialect
EncryptionInfo.Type
Possible encryption types.
Protobuf enum google.spanner.admin.database.v1.EncryptionInfo.Type
RestoreDatabaseEncryptionConfig.EncryptionType
Encryption types for the database to be restored.
Protobuf enum
google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.EncryptionType
RestoreDatabaseMetadata.SourceInfoCase
RestoreDatabaseRequest.SourceCase
RestoreInfo.SourceInfoCase
RestoreSourceType
Indicates the type of the restore source.
Protobuf enum google.spanner.admin.database.v1.RestoreSourceType