Package-level declarations

Types

Link copied to clipboard
data class BackupInfoResponse(val backup: String, val createTime: String, val sourceDatabase: String, val versionTime: String)

Information about a backup.

Link copied to clipboard
data class BindingResponse(val condition: ExprResponse, val members: List<String>, val role: String)

Associates members, or principals, with a role.

Link copied to clipboard
data class EncryptionConfigResponse(val kmsKeyName: String)

Encryption configuration for a Cloud Spanner database.

Link copied to clipboard
data class EncryptionInfoResponse(val encryptionStatus: StatusResponse, val encryptionType: String, val kmsKeyVersion: String)

Encryption information for a Cloud Spanner database or backup.

Link copied to clipboard
data class ExprResponse(val description: String, val expression: String, val location: String, val title: String)

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

Link copied to clipboard
data class FreeInstanceMetadataResponse(val expireBehavior: String, val expireTime: String, val upgradeTime: String)

Free instance specific metadata that is kept even after an instance has been upgraded for tracking purposes.

Link copied to clipboard
data class GetBackupResult(val createTime: String, val database: String, val databaseDialect: String, val encryptionInfo: EncryptionInfoResponse, val expireTime: String, val maxExpireTime: String, val name: String, val referencingBackups: List<String>, val referencingDatabases: List<String>, val sizeBytes: String, val state: String, val versionTime: String)
Link copied to clipboard
data class GetDatabaseResult(val createTime: String, val databaseDialect: String, val defaultLeader: String, val earliestVersionTime: String, val enableDropProtection: Boolean, val encryptionConfig: EncryptionConfigResponse, val encryptionInfo: List<EncryptionInfoResponse>, val name: String, val reconciling: Boolean, val restoreInfo: RestoreInfoResponse, val state: String, val versionRetentionPeriod: String)
Link copied to clipboard
data class GetInstanceBackupIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetInstanceConfigResult(val baseConfig: String, val configType: String, val displayName: String, val etag: String, val freeInstanceAvailability: String, val labels: Map<String, String>, val leaderOptions: List<String>, val name: String, val optionalReplicas: List<ReplicaInfoResponse>, val reconciling: Boolean, val replicas: List<ReplicaInfoResponse>, val state: String)
Link copied to clipboard
data class GetInstanceDatabaseIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetInstanceIamPolicyResult(val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetInstanceResult(val config: String, val createTime: String, val displayName: String, val endpointUris: List<String>, val freeInstanceMetadata: FreeInstanceMetadataResponse, val instanceType: String, val labels: Map<String, String>, val name: String, val nodeCount: Int, val processingUnits: Int, val state: String, val updateTime: String)
Link copied to clipboard
data class GetSessionResult(val approximateLastUseTime: String, val createTime: String, val creatorRole: String, val labels: Map<String, String>, val name: String)
Link copied to clipboard
data class ReplicaInfoResponse(val defaultLeaderLocation: Boolean, val location: String, val type: String)
Link copied to clipboard
data class RestoreInfoResponse(val backupInfo: BackupInfoResponse, val sourceType: String)

Information about the database restore.

Link copied to clipboard
data class StatusResponse(val code: Int, val details: List<Map<String, String>>, val message: String)

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.