| Class | Description |
|---|---|
| AdapterSession |
A session in the Cloud Spanner Adapter API.
|
| AdaptMessageRequest |
Message sent by the client to the adapter.
|
| AdaptMessageResponse |
Message sent by the adapter to the client.
|
| AddSplitPointsRequest |
The request for AddSplitPoints.
|
| AddSplitPointsResponse |
The response for AddSplitPoints.
|
| AsymmetricAutoscalingOption |
AsymmetricAutoscalingOption specifies the scaling of replicas identified by the given selection.
|
| AutoscalingConfig |
Autoscaling configuration for an instance.
|
| AutoscalingConfigOverrides |
Overrides the top-level autoscaling configuration for the replicas identified by
`replica_selection`.
|
| AutoscalingLimits |
The autoscaling limits for the instance.
|
| AutoscalingTargets |
The autoscaling targets for an instance.
|
| Backup |
A backup of a Cloud Spanner database.
|
| BackupInfo |
Information about a backup.
|
| BackupInstancePartition |
Instance partition information for the backup.
|
| BackupSchedule |
BackupSchedule expresses the automated backup creation specification for a Spanner database.
|
| BackupScheduleSpec |
Defines specifications of the backup schedule.
|
| BatchCreateSessionsRequest |
The request for BatchCreateSessions.
|
| BatchCreateSessionsResponse |
The response for BatchCreateSessions.
|
| BatchWriteRequest |
The request for BatchWrite.
|
| BatchWriteResponse |
The result of applying a batch of mutations.
|
| BeginTransactionRequest |
The request for BeginTransaction.
|
| Binding |
Associates `members`, or principals, with a `role`.
|
| ChangeQuorumMetadata |
Metadata type for the long-running operation returned by ChangeQuorum.
|
| ChangeQuorumRequest |
The request for ChangeQuorum.
|
| ChangeStreamRecord |
Spanner Change Streams enable customers to capture and stream out changes to their Spanner
databases in real-time.
|
| ChildLink |
Metadata associated with a parent-child relationship appearing in a PlanNode.
|
| ColumnMetadata |
Metadata for a column.
|
| CommitRequest |
The request for Commit.
|
| CommitResponse |
The response for Commit.
|
| CommitStats |
Additional statistics about a commit.
|
| ContextValue |
A message representing context for a KeyRangeInfo, including a label, value, unit, and severity.
|
| CopyBackupEncryptionConfig |
Encryption configuration for the copied backup.
|
| CopyBackupMetadata |
Metadata type for the operation returned by CopyBackup.
|
| CopyBackupRequest |
The request for CopyBackup.
|
| CreateBackupEncryptionConfig |
Encryption configuration for the backup to create.
|
| CreateBackupMetadata |
Metadata type for the operation returned by CreateBackup.
|
| CreateDatabaseMetadata |
Metadata type for the operation returned by CreateDatabase.
|
| CreateDatabaseRequest |
The request for CreateDatabase.
|
| CreateInstanceConfigMetadata |
Metadata type for the operation returned by CreateInstanceConfig.
|
| CreateInstanceConfigRequest |
The request for CreateInstanceConfig.
|
| CreateInstanceMetadata |
Metadata type for the operation returned by CreateInstance.
|
| CreateInstancePartitionMetadata |
Metadata type for the operation returned by CreateInstancePartition.
|
| CreateInstancePartitionRequest |
The request for CreateInstancePartition.
|
| CreateInstanceRequest |
The request for CreateInstance.
|
| CreateSessionRequest |
The request for CreateSession.
|
| CrontabSpec |
CrontabSpec can be used to specify the version time and frequency at which the backup is created.
|
| Database |
A Cloud Spanner database.
|
| DatabaseMoveConfig |
The configuration for each database in the target instance configuration.
|
| DatabaseRole |
A Cloud Spanner database role.
|
| DataChangeRecord |
A data change record contains a set of changes to a table with the same modification type
(insert, update, or delete) committed at the same commit timestamp in one change stream partition
for the same transaction.
|
| DdlStatementActionInfo |
Action information extracted from a DDL statement.
|
| Delete |
Arguments to delete operations.
|
| DerivedMetric |
A message representing a derived metric.
|
| DiagnosticMessage |
A message representing the key visualizer diagnostic messages.
|
| DirectedReadOptions |
The `DirectedReadOptions` can be used to indicate which replicas or regions should be used for
non-transactional reads or queries.
|
| DualRegionQuorum |
Message type for a dual-region quorum.
|
| Empty |
A generic empty message that you can re-use to avoid defining duplicated empty messages in your
APIs.
|
| EncryptionConfig |
Encryption configuration for a Cloud Spanner database.
|
| EncryptionInfo |
Encryption information for a Cloud Spanner database or backup.
|
| ExcludeReplicas |
An ExcludeReplicas contains a repeated set of ReplicaSelection that should be excluded from
serving requests.
|
| ExecuteBatchDmlRequest |
The request for ExecuteBatchDml.
|
| ExecuteBatchDmlResponse |
The response for ExecuteBatchDml.
|
| ExecuteSqlRequest |
The request for ExecuteSql and ExecuteStreamingSql.
|
| Expr |
Represents a textual expression in the Common Expression Language (CEL) syntax.
|
| Field |
Message representing a single field of a struct.
|
| FreeInstanceMetadata |
Free instance specific metadata that is kept even after an instance has been upgraded for
tracking purposes.
|
| FullBackupSpec |
The specification for full backups.
|
| GetDatabaseDdlResponse |
The response for GetDatabaseDdl.
|
| GetIamPolicyRequest |
Request message for `GetIamPolicy` method.
|
| GetPolicyOptions |
Encapsulates settings provided to GetIamPolicy.
|
| HeartbeatRecord |
A heartbeat record is returned as a progress indicator, when there are no data changes or any
other partition record types in the change stream partition.
|
| IncludeReplicas |
An `IncludeReplicas` contains a repeated set of `ReplicaSelection` which indicates the order in
which replicas should be considered.
|
| IncrementalBackupSpec |
The specification for incremental backup chains.
|
| IndexAdvice |
Recommendation to add new indexes to run queries more efficiently.
|
| IndexedHotKey |
A message representing a (sparse) collection of hot keys for specific key buckets.
|
| IndexedKeyRangeInfos |
A message representing a (sparse) collection of KeyRangeInfos for specific key buckets.
|
| Instance |
An isolated set of Cloud Spanner resources on which databases can be hosted.
|
| InstanceConfig |
A possible configuration for a Cloud Spanner instance.
|
| InstanceEncryptionConfig |
Encryption configuration for a Cloud Spanner database.
|
| InstanceOperationProgress |
Encapsulates progress related information for a Cloud Spanner long running instance operations.
|
| InstancePartition |
An isolated set of Cloud Spanner resources that databases can define placements on.
|
| InstanceReplicaSelection |
ReplicaSelection identifies replicas with common properties.
|
| Key |
A split key.
|
| KeyRange |
KeyRange represents a range of rows in a table or index.
|
| KeyRangeInfo |
A message representing information for a key range (possibly one key).
|
| KeyRangeInfos |
A message representing a list of specific information for multiple key ranges.
|
| KeySet |
`KeySet` defines a collection of Cloud Spanner keys and/or key ranges.
|
| ListBackupOperationsResponse |
The response for ListBackupOperations.
|
| ListBackupSchedulesResponse |
The response for ListBackupSchedules.
|
| ListBackupsResponse |
The response for ListBackups.
|
| ListDatabaseOperationsResponse |
The response for ListDatabaseOperations.
|
| ListDatabaseRolesResponse |
The response for ListDatabaseRoles.
|
| ListDatabasesResponse |
The response for ListDatabases.
|
| ListInstanceConfigOperationsResponse |
The response for ListInstanceConfigOperations.
|
| ListInstanceConfigsResponse |
The response for ListInstanceConfigs.
|
| ListInstancePartitionOperationsResponse |
The response for ListInstancePartitionOperations.
|
| ListInstancePartitionsResponse |
The response for ListInstancePartitions.
|
| ListInstancesResponse |
The response for ListInstances.
|
| ListOperationsResponse |
The response message for Operations.ListOperations.
|
| ListScansResponse |
Response method from the ListScans method.
|
| ListSessionsResponse |
The response for ListSessions.
|
| LocalizedString |
A message representing a user-facing string whose value may need to be translated before being
displayed.
|
| Metric |
A message representing the actual monitoring data, values for each key bucket over time, of a
metric.
|
| MetricMatrix |
A message representing a matrix of floats.
|
| MetricMatrixRow |
A message representing a row of a matrix of floats.
|
| Mod |
A mod describes all data changes in a watched table row.
|
| ModValue |
Returns the value and associated metadata for a particular field of the Mod.
|
| MoveInEvent |
Describes move-in of the key ranges into the change stream partition identified by
partition_token.
|
| MoveInstanceRequest |
The request for MoveInstance.
|
| MoveOutEvent |
Describes move-out of the key ranges out of the change stream partition identified by
partition_token.
|
| MultiplexedSessionPrecommitToken |
When a read-write transaction is executed on a multiplexed session, this precommit token is sent
back to the client as a part of the Transaction message in the BeginTransaction response and also
as a part of the ResultSet and PartialResultSet responses.
|
| Mutation |
A modification to one or more Cloud Spanner rows.
|
| MutationGroup |
A group of mutations to be committed together.
|
| Operation |
This resource represents a long-running operation that is the result of a network API call.
|
| 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.
|
| PartialResultSet |
Partial results from a streaming read or SQL query.
|
| Partition |
Information returned for each partition returned in a PartitionResponse.
|
| PartitionedDml |
Message type to initiate a Partitioned DML transaction.
|
| PartitionEndRecord |
A partition end record serves as a notification that the client should stop reading the
partition.
|
| PartitionEventRecord |
A partition event record describes key range changes for a change stream partition.
|
| PartitionOptions |
Options for a `PartitionQueryRequest` and `PartitionReadRequest`.
|
| PartitionQueryRequest |
The request for PartitionQuery
|
| PartitionReadRequest |
The request for PartitionRead
|
| PartitionResponse |
The response for PartitionQuery or PartitionRead
|
| PartitionStartRecord |
A partition start record serves as a notification that the client should schedule the partitions
to be queried.
|
| PlanNode |
Node information for nodes appearing in a QueryPlan.plan_nodes.
|
| Policy |
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud
resources.
|
| PrefixNode |
A message representing a key prefix node in the key prefix hierarchy.
|
| QueryAdvisorResult |
Output of query advisor analysis.
|
| QueryOptions |
Query optimizer configuration.
|
| QueryPlan |
Contains an ordered list of nodes appearing in the query plan.
|
| QuorumInfo |
Information about the dual-region quorum.
|
| QuorumType |
Information about the database quorum type.
|
| ReadOnly |
Message type to initiate a read-only transaction.
|
| ReadRequest |
The request for Read and StreamingRead.
|
| ReadWrite |
Message type to initiate a read-write transaction.
|
| ReplicaComputeCapacity |
ReplicaComputeCapacity describes the amount of server resources that are allocated to each
replica identified by the replica selection.
|
| ReplicaInfo |
Model definition for ReplicaInfo.
|
| ReplicaSelection |
The directed read replica selector.
|
| RequestOptions |
Common request options for various APIs.
|
| RestoreDatabaseEncryptionConfig |
Encryption configuration for the restored database.
|
| RestoreDatabaseMetadata |
Metadata type for the long-running operation returned by RestoreDatabase.
|
| RestoreDatabaseRequest |
The request for RestoreDatabase.
|
| RestoreInfo |
Information about the database restore.
|
| ResultSet |
Results from Read or ExecuteSql.
|
| ResultSetMetadata |
Metadata about a ResultSet or PartialResultSet.
|
| ResultSetStats |
Additional statistics about a ResultSet or PartialResultSet.
|
| RollbackRequest |
The request for Rollback.
|
| Scan |
Scan is a structure which describes Cloud Key Visualizer scan information.
|
| ScanData |
ScanData contains Cloud Key Visualizer scan data used by the caller to construct a visualization.
|
| Session |
A session in the Cloud Spanner API.
|
| SetIamPolicyRequest |
Request message for `SetIamPolicy` method.
|
| ShortRepresentation |
Condensed representation of a node and its subtree.
|
| SingleRegionQuorum |
Message type for a single-region quorum.
|
| SplitPoints |
The split points of a table or an index.
|
| Statement |
A single DML statement.
|
| Status |
The `Status` type defines a logical error model that is suitable for different programming
environments, including REST APIs and RPC APIs.
|
| StructType |
`StructType` defines the fields of a STRUCT type.
|
| TestIamPermissionsRequest |
Request message for `TestIamPermissions` method.
|
| TestIamPermissionsResponse |
Response message for `TestIamPermissions` method.
|
| Transaction |
A transaction.
|
| TransactionOptions |
Options to use for transactions.
|
| TransactionSelector |
This message is used to select the transaction in which a Read or ExecuteSql call runs.
|
| Type |
`Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or
returned from an SQL query.
|
| UpdateDatabaseDdlMetadata |
Metadata type for the operation returned by 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.
|
| UpdateDatabaseMetadata |
Metadata type for the operation returned by UpdateDatabase.
|
| UpdateDatabaseRequest |
The request for UpdateDatabase.
|
| UpdateInstanceConfigMetadata |
Metadata type for the operation returned by UpdateInstanceConfig.
|
| UpdateInstanceConfigRequest |
The request for UpdateInstanceConfig.
|
| UpdateInstanceMetadata |
Metadata type for the operation returned by UpdateInstance.
|
| UpdateInstancePartitionMetadata |
Metadata type for the operation returned by UpdateInstancePartition.
|
| UpdateInstancePartitionRequest |
The request for UpdateInstancePartition.
|
| UpdateInstanceRequest |
The request for UpdateInstance.
|
| VisualizationData |
Model definition for VisualizationData.
|
| Write |
Arguments to insert, update, insert_or_update, and replace operations.
|
Copyright © 2011–2025 Google. All rights reserved.