Namespace Google.Apis.Spanner.v1.Data

Classes

AdaptMessageRequest

Message sent by the client to the adapter.

AdaptMessageResponse

Message sent by the adapter to the client.

AdapterSession

A session in the Cloud Spanner Adapter API.

AsymmetricAutoscalingOption

AsymmetricAutoscalingOption specifies the scaling of replicas identified by the given selection.

AutoscalingConfig

Autoscaling configuration for an instance.

Overrides the top-level autoscaling configuration for the replicas identified by replica_selection. All fields in this message are optional. Any unspecified fields will use the corresponding values from the top-level autoscaling configuration.

AutoscalingLimits

The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit.

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. A change stream can be created with option partition_mode='IMMUTABLE_KEY_RANGE' or partition_mode='MUTABLE_KEY_RANGE'. This message is only used in Change Streams created with the option partition_mode='MUTABLE_KEY_RANGE'. Spanner automatically creates a special Table-Valued Function (TVF) along with each Change Streams. The function provides access to the change stream's records. The function is named READ_ (where is the name of the change stream), and it returns a table with only one column called ChangeRecord.

ChildLink

Metadata associated with a parent-child relationship appearing in a PlanNode.

ClientContext

Container for various pieces of client-owned context attached to a request.

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.

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. Multiple data change records can be returned for the same transaction across multiple change stream partitions.

Database

A Cloud Spanner database.

DatabaseMoveConfig

The configuration for each database in the target instance configuration.

DatabaseRole

A Cloud Spanner database role.

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.

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. DirectedReadOptions can only be specified for a read-only transaction, otherwise the API returns an INVALID_ARGUMENT error.

DualRegionQuorum

Message type for a dual-region quorum. Currently this type has no options.

Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

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. Contains a list of ResultSet messages, one for each DML statement that has successfully executed, in the same order as the statements in the request. If a statement fails, the status in the response body identifies the cause of the failure. To check for DML statements that failed, use the following approach: 1. Check the status in the response message. The google.rpc.Code enum value OK indicates that all statements were executed successfully. 2. If the status was not OK, check the number of result sets in the response. If the response contains N ResultSet messages, then statement N+1 in the request failed. Example 1: * Request: 5 DML statements, all executed successfully. * Response: 5 ResultSet messages, with the status OK. Example 2: * Request: 5 DML statements. The third statement has a syntax error. * Response: 2 ResultSet messages, and a syntax error (INVALID_ARGUMENT) status. The number of ResultSet messages indicates that the third statement failed, and the fourth and fifth statements were not executed.

ExecuteSqlRequest

The request for ExecuteSql and ExecuteStreamingSql.

Expr

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.

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. A full backup stores the entire contents of the database at a given version time.

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. An incremental backup stores the delta of changes between a previous backup and the database contents at a given version time. An incremental backup chain consists of a full backup and zero or more successive incremental backups. The first backup created for an incremental backup chain is always a full backup.

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. Configurations define the geographic placement of nodes and their replication.

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. A range has a start key and an end key. These keys can be open or closed, indicating if the range includes rows with that key. Keys are represented by lists, where the ith value in the list corresponds to the ith component of the table or index primary key. Individual values are encoded as described here. For example, consider the following table definition: CREATE TABLE UserEvents ( UserName STRING(MAX), EventDate STRING(10) ) PRIMARY KEY(UserName, EventDate); The following keys name rows in this table: "Bob", "2014-09-23" Since the UserEvents table's PRIMARY KEY clause names two columns, each UserEvents key has two elements; the first is the UserName, and the second is the EventDate. Key ranges with multiple components are interpreted lexicographically by component using the table or index key's declared sort order. For example, the following range returns all events for user "Bob" that occurred in the year 2015: "start_closed": ["Bob", "2015-01-01"] "end_closed": ["Bob", "2015-12-31"] Start and end keys can omit trailing key components. This affects the inclusion and exclusion of rows that exactly match the provided key components: if the key is closed, then rows that exactly match the provided components are included; if the key is open, then rows that exactly match are not included. For example, the following range includes all events for "Bob" that occurred during and after the year 2000: "start_closed": ["Bob", "2000-01-01"] "end_closed": ["Bob"] The next example retrieves all events for "Bob": "start_closed": ["Bob"] "end_closed": ["Bob"] To retrieve events before the year 2000: "start_closed": ["Bob"] "end_open": ["Bob", "2000-01-01"] The following range includes all rows in the table: "start_closed": [] "end_closed": [] This range returns all users whose UserName begins with any character from A to C: "start_closed": ["A"] "end_open": ["D"] This range returns all users whose UserName begins with B: "start_closed": ["B"] "end_open": ["C"] Key ranges honor column sort order. For example, suppose a table is defined as follows: CREATE TABLE DescendingSortedTable { Key INT64, ... ) PRIMARY KEY(Key DESC); The following range retrieves all rows with key values between 1 and 100 inclusive: "start_closed": ["100"] "end_closed": ["1"] Note that 100 is passed as the start, and 1 is passed as the end, because Key is a descending column in the schema.

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. All the keys are expected to be in the same table or index. The keys need not be sorted in any particular way. If the same key is specified multiple times in the set (for example if two ranges, two keys, or a key and a range overlap), Cloud Spanner behaves as if the key were only specified once.

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. To maintain processing the changes for a particular key in timestamp order, the query processing the change stream partition identified by partition_token should not advance beyond the partition event record commit timestamp until the queries processing the source change stream partitions have processed all change stream records with timestamps <= the partition event record commit timestamp.

MoveInstanceRequest

The request for MoveInstance.

MoveOutEvent

Describes move-out of the key ranges out of the change stream partition identified by partition_token. To maintain processing the changes for a particular key in timestamp order, the query processing the MoveOutEvent in the partition identified by partition_token should inform the queries processing the destination partitions that they can unblock and proceed processing records past the commit_timestamp.

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. Mutations can be applied to a Cloud Spanner database by sending them in a Commit call.

MutationGroup

A group of mutations to be committed together. Related mutations should be placed in a group. For example, two mutations inserting rows with the same primary key prefix in both parent and child tables are related.

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. This long-running operation is automatically created by the system after the successful completion of a database restore, and cannot be cancelled.

PartialResultSet

Partial results from a streaming read or SQL query. Streaming reads and SQL queries better tolerate large result sets, large rows, and large values, but are a little trickier to consume.

Partition

Information returned for each partition returned in a PartitionResponse.

PartitionEndRecord

A partition end record serves as a notification that the client should stop reading the partition. No further records are expected to be retrieved on it.

PartitionEventRecord

A partition event record describes key range changes for a change stream partition. The changes to a row defined by its primary key can be captured in one change stream partition for a specific time range, and then be captured in a different change stream partition for a different time range. This movement of key ranges across change stream partitions is a reflection of activities, such as Spanner's dynamic splitting and load balancing, etc. Processing this event is needed if users want to guarantee processing of the changes for any key in timestamp order. If time ordered processing of changes for a primary key is not needed, this event can be ignored. To guarantee time ordered processing for each primary key, if the event describes move-ins, the reader of this partition needs to wait until the readers of the source partitions have processed all records with timestamps <= this PartitionEventRecord.commit_timestamp, before advancing beyond this PartitionEventRecord. If the event describes move-outs, the reader can notify the readers of the destination partitions that they can continue processing.

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. PartitionStartRecord returns information about one or more partitions.

PartitionedDml

Message type to initiate a Partitioned DML transaction.

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. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example:

{
"bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com",
"group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] },
{ "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": {
"title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time
&lt; timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

YAML example:

bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com -
serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin -
members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable
access description: Does not grant access after Sep 2020 expression: request.time &lt;
timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3

For a description of IAM and its features, see the IAM documentation.

PrefixNode

A message representing a key prefix node in the key prefix hierarchy. for eg. Bigtable keyspaces are lexicographically ordered mappings of keys to values. Keys often have a shared prefix structure where users use the keys to organize data. Eg ///employee In this case Keysight will possibly use one node for a company and reuse it for all employees that fall under the company. Doing so improves legibility in the UI.

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. This only applies to dual-region instance configs.

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. Currently this transaction type has no options.

ReplicaComputeCapacity

ReplicaComputeCapacity describes the amount of server resources that are allocated to each replica identified by the replica selection.

ReplicaInfo

ReplicaSelection

The directed read replica selector. Callers must provide one or more of the following fields for replica selection: * location - The location must be one of the regions within the multi-region configuration of your database. * type - The type of the replica. Some examples of using replica_selectors are: * location:us-east1 --> The "us-east1" replica(s) of any available type is used to process the request. * type:READ_ONLY --> The "READ_ONLY" type replica(s) in the nearest available location are used to process the request. * location:us-east1 type:READ_ONLY --> The "READ_ONLY" type replica(s) in location "us-east1" is used to process the request.

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. Only present for SCALAR PlanNode(s).

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. 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.

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. See TransactionOptions for more information about transactions.

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. 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 (for example, 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.