# -*- coding: utf-8 -*- # Copyright 2025 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # from __future__ import annotations from typing import MutableMapping, MutableSequence import proto # type: ignore from cloudsdk.google.protobuf import duration_pb2 # type: ignore from cloudsdk.google.protobuf import struct_pb2 # type: ignore from cloudsdk.google.protobuf import timestamp_pb2 # type: ignore from google.rpc import status_pb2 # type: ignore from googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types import keys from googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types import mutation from googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types import result_set from googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types import transaction as gs_transaction from googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types import type as gs_type __protobuf__ = proto.module( package='google.spanner.v1', manifest={ 'CreateSessionRequest', 'BatchCreateSessionsRequest', 'BatchCreateSessionsResponse', 'Session', 'GetSessionRequest', 'ListSessionsRequest', 'ListSessionsResponse', 'DeleteSessionRequest', 'RequestOptions', 'DirectedReadOptions', 'ExecuteSqlRequest', 'ExecuteBatchDmlRequest', 'ExecuteBatchDmlResponse', 'PartitionOptions', 'PartitionQueryRequest', 'PartitionReadRequest', 'Partition', 'PartitionResponse', 'ReadRequest', 'BeginTransactionRequest', 'CommitRequest', 'RollbackRequest', 'BatchWriteRequest', 'BatchWriteResponse', }, ) class CreateSessionRequest(proto.Message): r"""The request for [CreateSession][google.spanner.v1.Spanner.CreateSession]. Attributes: database (str): Required. The database in which the new session is created. session (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.Session): Required. The session to create. """ database: str = proto.Field( proto.STRING, number=1, ) session: 'Session' = proto.Field( proto.MESSAGE, number=2, message='Session', ) class BatchCreateSessionsRequest(proto.Message): r"""The request for [BatchCreateSessions][google.spanner.v1.Spanner.BatchCreateSessions]. Attributes: database (str): Required. The database in which the new sessions are created. session_template (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.Session): Parameters to apply to each created session. session_count (int): Required. The number of sessions to be created in this batch call. At least one session is created. The API can return fewer than the requested number of sessions. If a specific number of sessions are desired, the client can make additional calls to ``BatchCreateSessions`` (adjusting [session_count][google.spanner.v1.BatchCreateSessionsRequest.session_count] as necessary). """ database: str = proto.Field( proto.STRING, number=1, ) session_template: 'Session' = proto.Field( proto.MESSAGE, number=2, message='Session', ) session_count: int = proto.Field( proto.INT32, number=3, ) class BatchCreateSessionsResponse(proto.Message): r"""The response for [BatchCreateSessions][google.spanner.v1.Spanner.BatchCreateSessions]. Attributes: session (MutableSequence[googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.Session]): The freshly created sessions. """ session: MutableSequence['Session'] = proto.RepeatedField( proto.MESSAGE, number=1, message='Session', ) class Session(proto.Message): r"""A session in the Cloud Spanner API. Attributes: name (str): Output only. The name of the session. This is always system-assigned. labels (MutableMapping[str, str]): The labels for the session. - Label keys must be between 1 and 63 characters long and must conform to the following regular expression: ``[a-z]([-a-z0-9]*[a-z0-9])?``. - Label values must be between 0 and 63 characters long and must conform to the regular expression ``([a-z]([-a-z0-9]*[a-z0-9])?)?``. - No more than 64 labels can be associated with a given session. See https://goo.gl/xmQnxf for more information on and examples of labels. create_time (google.protobuf.timestamp_pb2.Timestamp): Output only. The timestamp when the session is created. approximate_last_use_time (google.protobuf.timestamp_pb2.Timestamp): Output only. The approximate timestamp when the session is last used. It's typically earlier than the actual last use time. creator_role (str): The database role which created this session. multiplexed (bool): Optional. If ``true``, specifies a multiplexed session. Use a multiplexed session for multiple, concurrent operations including any combination of read-only and read-write transactions. Use [``sessions.create``][google.spanner.v1.Spanner.CreateSession] to create multiplexed sessions. Don't use [BatchCreateSessions][google.spanner.v1.Spanner.BatchCreateSessions] to create a multiplexed session. You can't delete or list multiplexed sessions. """ name: str = proto.Field( proto.STRING, number=1, ) labels: MutableMapping[str, str] = proto.MapField( proto.STRING, proto.STRING, number=2, ) create_time: timestamp_pb2.Timestamp = proto.Field( proto.MESSAGE, number=3, message=timestamp_pb2.Timestamp, ) approximate_last_use_time: timestamp_pb2.Timestamp = proto.Field( proto.MESSAGE, number=4, message=timestamp_pb2.Timestamp, ) creator_role: str = proto.Field( proto.STRING, number=5, ) multiplexed: bool = proto.Field( proto.BOOL, number=6, ) class GetSessionRequest(proto.Message): r"""The request for [GetSession][google.spanner.v1.Spanner.GetSession]. Attributes: name (str): Required. The name of the session to retrieve. """ name: str = proto.Field( proto.STRING, number=1, ) class ListSessionsRequest(proto.Message): r"""The request for [ListSessions][google.spanner.v1.Spanner.ListSessions]. Attributes: database (str): Required. The database in which to list sessions. page_size (int): Number of sessions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. page_token (str): If non-empty, ``page_token`` should contain a [next_page_token][google.spanner.v1.ListSessionsResponse.next_page_token] from a previous [ListSessionsResponse][google.spanner.v1.ListSessionsResponse]. filter (str): An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: - ``labels.key`` where key is the name of a label Some examples of using filters are: - ``labels.env:*`` --> The session has the label "env". - ``labels.env:dev`` --> The session has the label "env" and the value of the label contains the string "dev". """ database: str = proto.Field( proto.STRING, number=1, ) page_size: int = proto.Field( proto.INT32, number=2, ) page_token: str = proto.Field( proto.STRING, number=3, ) filter: str = proto.Field( proto.STRING, number=4, ) class ListSessionsResponse(proto.Message): r"""The response for [ListSessions][google.spanner.v1.Spanner.ListSessions]. Attributes: sessions (MutableSequence[googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.Session]): The list of requested sessions. next_page_token (str): ``next_page_token`` can be sent in a subsequent [ListSessions][google.spanner.v1.Spanner.ListSessions] call to fetch more of the matching sessions. """ @property def raw_page(self): return self sessions: MutableSequence['Session'] = proto.RepeatedField( proto.MESSAGE, number=1, message='Session', ) next_page_token: str = proto.Field( proto.STRING, number=2, ) class DeleteSessionRequest(proto.Message): r"""The request for [DeleteSession][google.spanner.v1.Spanner.DeleteSession]. Attributes: name (str): Required. The name of the session to delete. """ name: str = proto.Field( proto.STRING, number=1, ) class RequestOptions(proto.Message): r"""Common request options for various APIs. Attributes: priority (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.RequestOptions.Priority): Priority for the request. request_tag (str): A per-request tag which can be applied to queries or reads, used for statistics collection. Both ``request_tag`` and ``transaction_tag`` can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (for example, ``CommitRequest``). Legal characters for ``request_tag`` values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (\_) characters are removed from the string. transaction_tag (str): A tag used for statistics collection about this transaction. Both ``request_tag`` and ``transaction_tag`` can be specified for a read or query that belongs to a transaction. To enable tagging on a transaction, ``transaction_tag`` must be set to the same value for all requests belonging to the same transaction, including [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction]. If this request doesn't belong to any transaction, ``transaction_tag`` is ignored. Legal characters for ``transaction_tag`` values are all printable characters (ASCII 32 - 126) and the length of a ``transaction_tag`` is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (\_) characters are removed from the string. """ class Priority(proto.Enum): r"""The relative priority for requests. Note that priority isn't applicable for [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction]. The priority acts as a hint to the Cloud Spanner scheduler and doesn't guarantee priority or order of execution. For example: - Some parts of a write operation always execute at ``PRIORITY_HIGH``, regardless of the specified priority. This can cause you to see an increase in high priority workload even when executing a low priority request. This can also potentially cause a priority inversion where a lower priority request is fulfilled ahead of a higher priority request. - If a transaction contains multiple operations with different priorities, Cloud Spanner doesn't guarantee to process the higher priority operations first. There might be other constraints to satisfy, such as the order of operations. Values: PRIORITY_UNSPECIFIED (0): ``PRIORITY_UNSPECIFIED`` is equivalent to ``PRIORITY_HIGH``. PRIORITY_LOW (1): This specifies that the request is low priority. PRIORITY_MEDIUM (2): This specifies that the request is medium priority. PRIORITY_HIGH (3): This specifies that the request is high priority. """ PRIORITY_UNSPECIFIED = 0 PRIORITY_LOW = 1 PRIORITY_MEDIUM = 2 PRIORITY_HIGH = 3 priority: Priority = proto.Field( proto.ENUM, number=1, enum=Priority, ) request_tag: str = proto.Field( proto.STRING, number=2, ) transaction_tag: str = proto.Field( proto.STRING, number=3, ) class DirectedReadOptions(proto.Message): r"""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. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields Attributes: include_replicas (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.DirectedReadOptions.IncludeReplicas): ``Include_replicas`` indicates the order of replicas (as they appear in this list) to process the request. If ``auto_failover_disabled`` is set to ``true`` and all replicas are exhausted without finding a healthy replica, Spanner waits for a replica in the list to become available, requests might fail due to ``DEADLINE_EXCEEDED`` errors. This field is a member of `oneof`_ ``replicas``. exclude_replicas (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.DirectedReadOptions.ExcludeReplicas): ``Exclude_replicas`` indicates that specified replicas should be excluded from serving requests. Spanner doesn't route requests to the replicas in this list. This field is a member of `oneof`_ ``replicas``. """ class ReplicaSelection(proto.Message): r"""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. Attributes: location (str): The location or region of the serving requests, for example, "us-east1". type_ (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.DirectedReadOptions.ReplicaSelection.Type): The type of replica. """ class Type(proto.Enum): r"""Indicates the type of replica. Values: TYPE_UNSPECIFIED (0): Not specified. READ_WRITE (1): Read-write replicas support both reads and writes. READ_ONLY (2): Read-only replicas only support reads (not writes). """ TYPE_UNSPECIFIED = 0 READ_WRITE = 1 READ_ONLY = 2 location: str = proto.Field( proto.STRING, number=1, ) type_: 'DirectedReadOptions.ReplicaSelection.Type' = proto.Field( proto.ENUM, number=2, enum='DirectedReadOptions.ReplicaSelection.Type', ) class IncludeReplicas(proto.Message): r"""An ``IncludeReplicas`` contains a repeated set of ``ReplicaSelection`` which indicates the order in which replicas should be considered. Attributes: replica_selections (MutableSequence[googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.DirectedReadOptions.ReplicaSelection]): The directed read replica selector. auto_failover_disabled (bool): If ``true``, Spanner doesn't route requests to a replica outside the <``include_replicas`` list when all of the specified replicas are unavailable or unhealthy. Default value is ``false``. """ replica_selections: MutableSequence['DirectedReadOptions.ReplicaSelection'] = proto.RepeatedField( proto.MESSAGE, number=1, message='DirectedReadOptions.ReplicaSelection', ) auto_failover_disabled: bool = proto.Field( proto.BOOL, number=2, ) class ExcludeReplicas(proto.Message): r"""An ExcludeReplicas contains a repeated set of ReplicaSelection that should be excluded from serving requests. Attributes: replica_selections (MutableSequence[googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.DirectedReadOptions.ReplicaSelection]): The directed read replica selector. """ replica_selections: MutableSequence['DirectedReadOptions.ReplicaSelection'] = proto.RepeatedField( proto.MESSAGE, number=1, message='DirectedReadOptions.ReplicaSelection', ) include_replicas: IncludeReplicas = proto.Field( proto.MESSAGE, number=1, oneof='replicas', message=IncludeReplicas, ) exclude_replicas: ExcludeReplicas = proto.Field( proto.MESSAGE, number=2, oneof='replicas', message=ExcludeReplicas, ) class ExecuteSqlRequest(proto.Message): r"""The request for [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql]. Attributes: session (str): Required. The session in which the SQL query should be performed. transaction (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.TransactionSelector): The transaction to use. For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency. Standard DML statements require a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction. Partitioned DML requires an existing Partitioned DML transaction ID. sql (str): Required. The SQL string. params (google.protobuf.struct_pb2.Struct): Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the ``@`` character followed by the parameter name (for example, ``@firstName``). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: ``"WHERE id > @msg_id AND id < @msg_id + 100"`` It's an error to execute a SQL statement with unbound parameters. param_types (MutableMapping[str, googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.Type]): It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type ``BYTES`` and values of type ``STRING`` both appear in [params][google.spanner.v1.ExecuteSqlRequest.params] as JSON strings. In these cases, you can use ``param_types`` to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of [Type][google.spanner.v1.Type] for more information about SQL types. resume_token (bytes): If this request is resuming a previously interrupted SQL statement execution, ``resume_token`` should be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption. Doing this enables the new SQL statement execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token. query_mode (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.ExecuteSqlRequest.QueryMode): Used to control the amount of debugging information returned in [ResultSetStats][google.spanner.v1.ResultSetStats]. If [partition_token][google.spanner.v1.ExecuteSqlRequest.partition_token] is set, [query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode] can only be set to [QueryMode.NORMAL][google.spanner.v1.ExecuteSqlRequest.QueryMode.NORMAL]. partition_token (bytes): If present, results are restricted to the specified partition previously created using ``PartitionQuery``. There must be an exact match for the values of fields common to this message and the ``PartitionQueryRequest`` message used to create this ``partition_token``. seqno (int): A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one succeeds. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction can be aborted. Replays of previously handled requests yield the same response as the first execution. Required for DML statements. Ignored for queries. query_options (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.ExecuteSqlRequest.QueryOptions): Query optimizer configuration to use for the given query. request_options (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.RequestOptions): Common options for this request. directed_read_options (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.DirectedReadOptions): Directed read options for this request. data_boost_enabled (bool): If this is for a partitioned query and this field is set to ``true``, the request is executed with Spanner Data Boost independent compute resources. If the field is set to ``true`` but the request doesn't set ``partition_token``, the API returns an ``INVALID_ARGUMENT`` error. last_statement (bool): Optional. If set to ``true``, this statement marks the end of the transaction. After this statement executes, you must commit or abort the transaction. Attempts to execute any other requests against this transaction (including reads and queries) are rejected. For DML statements, setting this option might cause some error reporting to be deferred until commit time (for example, validation of unique constraints). Given this, successful execution of a DML statement shouldn't be assumed until a subsequent ``Commit`` call completes successfully. """ class QueryMode(proto.Enum): r"""Mode in which the statement must be processed. Values: NORMAL (0): The default mode. Only the statement results are returned. PLAN (1): This mode returns only the query plan, without any results or execution statistics information. PROFILE (2): This mode returns the query plan, overall execution statistics, operator level execution statistics along with the results. This has a performance overhead compared to the other modes. It isn't recommended to use this mode for production traffic. WITH_STATS (3): This mode returns the overall (but not operator-level) execution statistics along with the results. WITH_PLAN_AND_STATS (4): This mode returns the query plan, overall (but not operator-level) execution statistics along with the results. """ NORMAL = 0 PLAN = 1 PROFILE = 2 WITH_STATS = 3 WITH_PLAN_AND_STATS = 4 class QueryOptions(proto.Message): r"""Query optimizer configuration. Attributes: optimizer_version (str): An option to control the selection of optimizer version. This parameter allows individual queries to pick different query optimizer versions. Specifying ``latest`` as a value instructs Cloud Spanner to use the latest supported query optimizer version. If not specified, Cloud Spanner uses the optimizer version set at the database level options. Any other positive integer (from the list of supported optimizer versions) overrides the default optimizer version for query execution. The list of supported optimizer versions can be queried from ``SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS``. Executing a SQL statement with an invalid optimizer version fails with an ``INVALID_ARGUMENT`` error. See https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer for more information on managing the query optimizer. The ``optimizer_version`` statement hint has precedence over this setting. optimizer_statistics_package (str): An option to control the selection of optimizer statistics package. This parameter allows individual queries to use a different query optimizer statistics package. Specifying ``latest`` as a value instructs Cloud Spanner to use the latest generated statistics package. If not specified, Cloud Spanner uses the statistics package set at the database level options, or the latest package if the database option isn't set. The statistics package requested by the query has to be exempt from garbage collection. This can be achieved with the following DDL statement: .. code:: sql ALTER STATISTICS SET OPTIONS (allow_gc=false) The list of available statistics packages can be queried from ``INFORMATION_SCHEMA.SPANNER_STATISTICS``. Executing a SQL statement with an invalid optimizer statistics package or with a statistics package that allows garbage collection fails with an ``INVALID_ARGUMENT`` error. """ optimizer_version: str = proto.Field( proto.STRING, number=1, ) optimizer_statistics_package: str = proto.Field( proto.STRING, number=2, ) session: str = proto.Field( proto.STRING, number=1, ) transaction: gs_transaction.TransactionSelector = proto.Field( proto.MESSAGE, number=2, message=gs_transaction.TransactionSelector, ) sql: str = proto.Field( proto.STRING, number=3, ) params: struct_pb2.Struct = proto.Field( proto.MESSAGE, number=4, message=struct_pb2.Struct, ) param_types: MutableMapping[str, gs_type.Type] = proto.MapField( proto.STRING, proto.MESSAGE, number=5, message=gs_type.Type, ) resume_token: bytes = proto.Field( proto.BYTES, number=6, ) query_mode: QueryMode = proto.Field( proto.ENUM, number=7, enum=QueryMode, ) partition_token: bytes = proto.Field( proto.BYTES, number=8, ) seqno: int = proto.Field( proto.INT64, number=9, ) query_options: QueryOptions = proto.Field( proto.MESSAGE, number=10, message=QueryOptions, ) request_options: 'RequestOptions' = proto.Field( proto.MESSAGE, number=11, message='RequestOptions', ) directed_read_options: 'DirectedReadOptions' = proto.Field( proto.MESSAGE, number=15, message='DirectedReadOptions', ) data_boost_enabled: bool = proto.Field( proto.BOOL, number=16, ) last_statement: bool = proto.Field( proto.BOOL, number=17, ) class ExecuteBatchDmlRequest(proto.Message): r"""The request for [ExecuteBatchDml][google.spanner.v1.Spanner.ExecuteBatchDml]. Attributes: session (str): Required. The session in which the DML statements should be performed. transaction (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.TransactionSelector): Required. The transaction to use. Must be a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction. statements (MutableSequence[googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.ExecuteBatchDmlRequest.Statement]): Required. The list of statements to execute in this batch. Statements are executed serially, such that the effects of statement ``i`` are visible to statement ``i+1``. Each statement must be a DML statement. Execution stops at the first failed statement; the remaining statements are not executed. Callers must provide at least one statement. seqno (int): Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one succeeds. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction might be aborted. Replays of previously handled requests yield the same response as the first execution. request_options (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.RequestOptions): Common options for this request. last_statements (bool): Optional. If set to ``true``, this request marks the end of the transaction. After these statements execute, you must commit or abort the transaction. Attempts to execute any other requests against this transaction (including reads and queries) are rejected. Setting this option might cause some error reporting to be deferred until commit time (for example, validation of unique constraints). Given this, successful execution of statements shouldn't be assumed until a subsequent ``Commit`` call completes successfully. """ class Statement(proto.Message): r"""A single DML statement. Attributes: sql (str): Required. The DML string. params (google.protobuf.struct_pb2.Struct): Parameter names and values that bind to placeholders in the DML string. A parameter placeholder consists of the ``@`` character followed by the parameter name (for example, ``@firstName``). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: ``"WHERE id > @msg_id AND id < @msg_id + 100"`` It's an error to execute a SQL statement with unbound parameters. param_types (MutableMapping[str, googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.Type]): It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type ``BYTES`` and values of type ``STRING`` both appear in [params][google.spanner.v1.ExecuteBatchDmlRequest.Statement.params] as JSON strings. In these cases, ``param_types`` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of [Type][google.spanner.v1.Type] for more information about SQL types. """ sql: str = proto.Field( proto.STRING, number=1, ) params: struct_pb2.Struct = proto.Field( proto.MESSAGE, number=2, message=struct_pb2.Struct, ) param_types: MutableMapping[str, gs_type.Type] = proto.MapField( proto.STRING, proto.MESSAGE, number=3, message=gs_type.Type, ) session: str = proto.Field( proto.STRING, number=1, ) transaction: gs_transaction.TransactionSelector = proto.Field( proto.MESSAGE, number=2, message=gs_transaction.TransactionSelector, ) statements: MutableSequence[Statement] = proto.RepeatedField( proto.MESSAGE, number=3, message=Statement, ) seqno: int = proto.Field( proto.INT64, number=4, ) request_options: 'RequestOptions' = proto.Field( proto.MESSAGE, number=5, message='RequestOptions', ) last_statements: bool = proto.Field( proto.BOOL, number=6, ) class ExecuteBatchDmlResponse(proto.Message): r"""The response for [ExecuteBatchDml][google.spanner.v1.Spanner.ExecuteBatchDml]. Contains a list of [ResultSet][google.spanner.v1.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][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][google.spanner.v1.ResultSet] messages, then statement ``N+1`` in the request failed. Example 1: - Request: 5 DML statements, all executed successfully. - Response: 5 [ResultSet][google.spanner.v1.ResultSet] messages, with the status ``OK``. Example 2: - Request: 5 DML statements. The third statement has a syntax error. - Response: 2 [ResultSet][google.spanner.v1.ResultSet] messages, and a syntax error (``INVALID_ARGUMENT``) status. The number of [ResultSet][google.spanner.v1.ResultSet] messages indicates that the third statement failed, and the fourth and fifth statements were not executed. Attributes: result_sets (MutableSequence[googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.ResultSet]): One [ResultSet][google.spanner.v1.ResultSet] for each statement in the request that ran successfully, in the same order as the statements in the request. Each [ResultSet][google.spanner.v1.ResultSet] does not contain any rows. The [ResultSetStats][google.spanner.v1.ResultSetStats] in each [ResultSet][google.spanner.v1.ResultSet] contain the number of rows modified by the statement. Only the first [ResultSet][google.spanner.v1.ResultSet] in the response contains valid [ResultSetMetadata][google.spanner.v1.ResultSetMetadata]. status (google.rpc.status_pb2.Status): If all DML statements are executed successfully, the status is ``OK``. Otherwise, the error status of the first failed statement. precommit_token (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.MultiplexedSessionPrecommitToken): Optional. A precommit token is included if the read-write transaction is on a multiplexed session. Pass the precommit token with the highest sequence number from this transaction attempt should be passed to the [Commit][google.spanner.v1.Spanner.Commit] request for this transaction. """ result_sets: MutableSequence[result_set.ResultSet] = proto.RepeatedField( proto.MESSAGE, number=1, message=result_set.ResultSet, ) status: status_pb2.Status = proto.Field( proto.MESSAGE, number=2, message=status_pb2.Status, ) precommit_token: gs_transaction.MultiplexedSessionPrecommitToken = proto.Field( proto.MESSAGE, number=3, message=gs_transaction.MultiplexedSessionPrecommitToken, ) class PartitionOptions(proto.Message): r"""Options for a ``PartitionQueryRequest`` and ``PartitionReadRequest``. Attributes: partition_size_bytes (int): **Note:** This hint is currently ignored by ``PartitionQuery`` and ``PartitionRead`` requests. The desired data size for each partition generated. The default for this option is currently 1 GiB. This is only a hint. The actual size of each partition can be smaller or larger than this size request. max_partitions (int): **Note:** This hint is currently ignored by ``PartitionQuery`` and ``PartitionRead`` requests. The desired maximum number of partitions to return. For example, this might be set to the number of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual number of partitions returned can be smaller or larger than this maximum count request. """ partition_size_bytes: int = proto.Field( proto.INT64, number=1, ) max_partitions: int = proto.Field( proto.INT64, number=2, ) class PartitionQueryRequest(proto.Message): r"""The request for [PartitionQuery][google.spanner.v1.Spanner.PartitionQuery] Attributes: session (str): Required. The session used to create the partitions. transaction (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.TransactionSelector): Read-only snapshot transactions are supported, read and write and single-use transactions are not. sql (str): Required. The query request to generate partitions for. The request fails if the query isn't root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see `Read data in parallel `__. The query request must not contain DML commands, such as ``INSERT``, ``UPDATE``, or ``DELETE``. Use [``ExecuteStreamingSql``][google.spanner.v1.Spanner.ExecuteStreamingSql] with a ``PartitionedDml`` transaction for large, partition-friendly DML operations. params (google.protobuf.struct_pb2.Struct): Optional. Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the ``@`` character followed by the parameter name (for example, ``@firstName``). Parameter names can contain letters, numbers, and underscores. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: ``"WHERE id > @msg_id AND id < @msg_id + 100"`` It's an error to execute a SQL statement with unbound parameters. param_types (MutableMapping[str, googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.Type]): Optional. It isn't always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type ``BYTES`` and values of type ``STRING`` both appear in [params][google.spanner.v1.PartitionQueryRequest.params] as JSON strings. In these cases, ``param_types`` can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of [Type][google.spanner.v1.Type] for more information about SQL types. partition_options (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.PartitionOptions): Additional options that affect how many partitions are created. """ session: str = proto.Field( proto.STRING, number=1, ) transaction: gs_transaction.TransactionSelector = proto.Field( proto.MESSAGE, number=2, message=gs_transaction.TransactionSelector, ) sql: str = proto.Field( proto.STRING, number=3, ) params: struct_pb2.Struct = proto.Field( proto.MESSAGE, number=4, message=struct_pb2.Struct, ) param_types: MutableMapping[str, gs_type.Type] = proto.MapField( proto.STRING, proto.MESSAGE, number=5, message=gs_type.Type, ) partition_options: 'PartitionOptions' = proto.Field( proto.MESSAGE, number=6, message='PartitionOptions', ) class PartitionReadRequest(proto.Message): r"""The request for [PartitionRead][google.spanner.v1.Spanner.PartitionRead] Attributes: session (str): Required. The session used to create the partitions. transaction (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.TransactionSelector): Read only snapshot transactions are supported, read/write and single use transactions are not. table (str): Required. The name of the table in the database to be read. index (str): If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table]. This index is used instead of the table primary key when interpreting [key_set][google.spanner.v1.PartitionReadRequest.key_set] and sorting result rows. See [key_set][google.spanner.v1.PartitionReadRequest.key_set] for further information. columns (MutableSequence[str]): The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request. key_set (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.KeySet): Required. ``key_set`` identifies the rows to be yielded. ``key_set`` names the primary keys of the rows in [table][google.spanner.v1.PartitionReadRequest.table] to be yielded, unless [index][google.spanner.v1.PartitionReadRequest.index] is present. If [index][google.spanner.v1.PartitionReadRequest.index] is present, then [key_set][google.spanner.v1.PartitionReadRequest.key_set] instead names index keys in [index][google.spanner.v1.PartitionReadRequest.index]. It isn't an error for the ``key_set`` to name rows that don't exist in the database. Read yields nothing for nonexistent rows. partition_options (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.PartitionOptions): Additional options that affect how many partitions are created. """ session: str = proto.Field( proto.STRING, number=1, ) transaction: gs_transaction.TransactionSelector = proto.Field( proto.MESSAGE, number=2, message=gs_transaction.TransactionSelector, ) table: str = proto.Field( proto.STRING, number=3, ) index: str = proto.Field( proto.STRING, number=4, ) columns: MutableSequence[str] = proto.RepeatedField( proto.STRING, number=5, ) key_set: keys.KeySet = proto.Field( proto.MESSAGE, number=6, message=keys.KeySet, ) partition_options: 'PartitionOptions' = proto.Field( proto.MESSAGE, number=9, message='PartitionOptions', ) class Partition(proto.Message): r"""Information returned for each partition returned in a PartitionResponse. Attributes: partition_token (bytes): This token can be passed to ``Read``, ``StreamingRead``, ``ExecuteSql``, or ``ExecuteStreamingSql`` requests to restrict the results to those identified by this partition token. """ partition_token: bytes = proto.Field( proto.BYTES, number=1, ) class PartitionResponse(proto.Message): r"""The response for [PartitionQuery][google.spanner.v1.Spanner.PartitionQuery] or [PartitionRead][google.spanner.v1.Spanner.PartitionRead] Attributes: partitions (MutableSequence[googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.Partition]): Partitions created by this request. transaction (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.Transaction): Transaction created by this request. """ partitions: MutableSequence['Partition'] = proto.RepeatedField( proto.MESSAGE, number=1, message='Partition', ) transaction: gs_transaction.Transaction = proto.Field( proto.MESSAGE, number=2, message=gs_transaction.Transaction, ) class ReadRequest(proto.Message): r"""The request for [Read][google.spanner.v1.Spanner.Read] and [StreamingRead][google.spanner.v1.Spanner.StreamingRead]. Attributes: session (str): Required. The session in which the read should be performed. transaction (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.TransactionSelector): The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency. table (str): Required. The name of the table in the database to be read. index (str): If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table]. This index is used instead of the table primary key when interpreting [key_set][google.spanner.v1.ReadRequest.key_set] and sorting result rows. See [key_set][google.spanner.v1.ReadRequest.key_set] for further information. columns (MutableSequence[str]): Required. The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching this request. key_set (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.KeySet): Required. ``key_set`` identifies the rows to be yielded. ``key_set`` names the primary keys of the rows in [table][google.spanner.v1.ReadRequest.table] to be yielded, unless [index][google.spanner.v1.ReadRequest.index] is present. If [index][google.spanner.v1.ReadRequest.index] is present, then [key_set][google.spanner.v1.ReadRequest.key_set] instead names index keys in [index][google.spanner.v1.ReadRequest.index]. If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is empty, rows are yielded in table primary key order (if [index][google.spanner.v1.ReadRequest.index] is empty) or index key order (if [index][google.spanner.v1.ReadRequest.index] is non-empty). If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field isn't empty, rows are yielded in an unspecified order. It isn't an error for the ``key_set`` to name rows that don't exist in the database. Read yields nothing for nonexistent rows. limit (int): If greater than zero, only the first ``limit`` rows are yielded. If ``limit`` is zero, the default is no limit. A limit can't be specified if ``partition_token`` is set. resume_token (bytes): If this request is resuming a previously interrupted read, ``resume_token`` should be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token. partition_token (bytes): If present, results are restricted to the specified partition previously created using ``PartitionRead``. There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token. request_options (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.RequestOptions): Common options for this request. directed_read_options (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.DirectedReadOptions): Directed read options for this request. data_boost_enabled (bool): If this is for a partitioned read and this field is set to ``true``, the request is executed with Spanner Data Boost independent compute resources. If the field is set to ``true`` but the request doesn't set ``partition_token``, the API returns an ``INVALID_ARGUMENT`` error. order_by (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.ReadRequest.OrderBy): Optional. Order for the returned rows. By default, Spanner returns result rows in primary key order except for PartitionRead requests. For applications that don't require rows to be returned in primary key (``ORDER_BY_PRIMARY_KEY``) order, setting ``ORDER_BY_NO_ORDER`` option allows Spanner to optimize row retrieval, resulting in lower latencies in certain cases (for example, bulk point lookups). lock_hint (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.ReadRequest.LockHint): Optional. Lock Hint for the request, it can only be used with read-write transactions. """ class OrderBy(proto.Enum): r"""An option to control the order in which rows are returned from a read. Values: ORDER_BY_UNSPECIFIED (0): Default value. ``ORDER_BY_UNSPECIFIED`` is equivalent to ``ORDER_BY_PRIMARY_KEY``. ORDER_BY_PRIMARY_KEY (1): Read rows are returned in primary key order. In the event that this option is used in conjunction with the ``partition_token`` field, the API returns an ``INVALID_ARGUMENT`` error. ORDER_BY_NO_ORDER (2): Read rows are returned in any order. """ ORDER_BY_UNSPECIFIED = 0 ORDER_BY_PRIMARY_KEY = 1 ORDER_BY_NO_ORDER = 2 class LockHint(proto.Enum): r"""A lock hint mechanism for reads done within a transaction. Values: LOCK_HINT_UNSPECIFIED (0): Default value. ``LOCK_HINT_UNSPECIFIED`` is equivalent to ``LOCK_HINT_SHARED``. LOCK_HINT_SHARED (1): Acquire shared locks. By default when you perform a read as part of a read-write transaction, Spanner acquires shared read locks, which allows other reads to still access the data until your transaction is ready to commit. When your transaction is committing and writes are being applied, the transaction attempts to upgrade to an exclusive lock for any data you are writing. For more information about locks, see `Lock modes `__. LOCK_HINT_EXCLUSIVE (2): Acquire exclusive locks. Requesting exclusive locks is beneficial if you observe high write contention, which means you notice that multiple transactions are concurrently trying to read and write to the same data, resulting in a large number of aborts. This problem occurs when two transactions initially acquire shared locks and then both try to upgrade to exclusive locks at the same time. In this situation both transactions are waiting for the other to give up their lock, resulting in a deadlocked situation. Spanner is able to detect this occurring and force one of the transactions to abort. However, this is a slow and expensive operation and results in lower performance. In this case it makes sense to acquire exclusive locks at the start of the transaction because then when multiple transactions try to act on the same data, they automatically get serialized. Each transaction waits its turn to acquire the lock and avoids getting into deadlock situations. Because the exclusive lock hint is just a hint, it shouldn't be considered equivalent to a mutex. In other words, you shouldn't use Spanner exclusive locks as a mutual exclusion mechanism for the execution of code outside of Spanner. **Note:** Request exclusive locks judiciously because they block others from reading that data for the entire transaction, rather than just when the writes are being performed. Unless you observe high write contention, you should use the default of shared read locks so you don't prematurely block other clients from reading the data that you're writing to. """ LOCK_HINT_UNSPECIFIED = 0 LOCK_HINT_SHARED = 1 LOCK_HINT_EXCLUSIVE = 2 session: str = proto.Field( proto.STRING, number=1, ) transaction: gs_transaction.TransactionSelector = proto.Field( proto.MESSAGE, number=2, message=gs_transaction.TransactionSelector, ) table: str = proto.Field( proto.STRING, number=3, ) index: str = proto.Field( proto.STRING, number=4, ) columns: MutableSequence[str] = proto.RepeatedField( proto.STRING, number=5, ) key_set: keys.KeySet = proto.Field( proto.MESSAGE, number=6, message=keys.KeySet, ) limit: int = proto.Field( proto.INT64, number=8, ) resume_token: bytes = proto.Field( proto.BYTES, number=9, ) partition_token: bytes = proto.Field( proto.BYTES, number=10, ) request_options: 'RequestOptions' = proto.Field( proto.MESSAGE, number=11, message='RequestOptions', ) directed_read_options: 'DirectedReadOptions' = proto.Field( proto.MESSAGE, number=14, message='DirectedReadOptions', ) data_boost_enabled: bool = proto.Field( proto.BOOL, number=15, ) order_by: OrderBy = proto.Field( proto.ENUM, number=16, enum=OrderBy, ) lock_hint: LockHint = proto.Field( proto.ENUM, number=17, enum=LockHint, ) class BeginTransactionRequest(proto.Message): r"""The request for [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction]. Attributes: session (str): Required. The session in which the transaction runs. options (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.TransactionOptions): Required. Options for the new transaction. request_options (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.RequestOptions): Common options for this request. Priority is ignored for this request. Setting the priority in this ``request_options`` struct doesn't do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead. mutation_key (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.Mutation): Optional. Required for read-write transactions on a multiplexed session that commit mutations but don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request. """ session: str = proto.Field( proto.STRING, number=1, ) options: gs_transaction.TransactionOptions = proto.Field( proto.MESSAGE, number=2, message=gs_transaction.TransactionOptions, ) request_options: 'RequestOptions' = proto.Field( proto.MESSAGE, number=3, message='RequestOptions', ) mutation_key: mutation.Mutation = proto.Field( proto.MESSAGE, number=4, message=mutation.Mutation, ) class CommitRequest(proto.Message): r"""The request for [Commit][google.spanner.v1.Spanner.Commit]. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields Attributes: session (str): Required. The session in which the transaction to be committed is running. transaction_id (bytes): Commit a previously-started transaction. This field is a member of `oneof`_ ``transaction``. single_use_transaction (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.TransactionOptions): Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the ``CommitRequest`` is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it's possible that the mutations are executed more than once. If this is undesirable, use [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction] and [Commit][google.spanner.v1.Spanner.Commit] instead. This field is a member of `oneof`_ ``transaction``. mutations (MutableSequence[googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.Mutation]): The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list. return_commit_stats (bool): If ``true``, then statistics related to the transaction is included in the [CommitResponse][google.spanner.v1.CommitResponse.commit_stats]. Default value is ``false``. max_commit_delay (google.protobuf.duration_pb2.Duration): Optional. The amount of latency this request is configured to incur in order to improve throughput. If this field isn't set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a commit delay value between 0 and 500 ms. request_options (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.RequestOptions): Common options for this request. precommit_token (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.MultiplexedSessionPrecommitToken): Optional. If the read-write transaction was executed on a multiplexed session, then you must include the precommit token with the highest sequence number received in this transaction attempt. Failing to do so results in a ``FailedPrecondition`` error. """ session: str = proto.Field( proto.STRING, number=1, ) transaction_id: bytes = proto.Field( proto.BYTES, number=2, oneof='transaction', ) single_use_transaction: gs_transaction.TransactionOptions = proto.Field( proto.MESSAGE, number=3, oneof='transaction', message=gs_transaction.TransactionOptions, ) mutations: MutableSequence[mutation.Mutation] = proto.RepeatedField( proto.MESSAGE, number=4, message=mutation.Mutation, ) return_commit_stats: bool = proto.Field( proto.BOOL, number=5, ) max_commit_delay: duration_pb2.Duration = proto.Field( proto.MESSAGE, number=8, message=duration_pb2.Duration, ) request_options: 'RequestOptions' = proto.Field( proto.MESSAGE, number=6, message='RequestOptions', ) precommit_token: gs_transaction.MultiplexedSessionPrecommitToken = proto.Field( proto.MESSAGE, number=9, message=gs_transaction.MultiplexedSessionPrecommitToken, ) class RollbackRequest(proto.Message): r"""The request for [Rollback][google.spanner.v1.Spanner.Rollback]. Attributes: session (str): Required. The session in which the transaction to roll back is running. transaction_id (bytes): Required. The transaction to roll back. """ session: str = proto.Field( proto.STRING, number=1, ) transaction_id: bytes = proto.Field( proto.BYTES, number=2, ) class BatchWriteRequest(proto.Message): r"""The request for [BatchWrite][google.spanner.v1.Spanner.BatchWrite]. Attributes: session (str): Required. The session in which the batch request is to be run. request_options (googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.RequestOptions): Common options for this request. mutation_groups (MutableSequence[googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.BatchWriteRequest.MutationGroup]): Required. The groups of mutations to be applied. exclude_txn_from_change_streams (bool): Optional. If you don't set the ``exclude_txn_from_change_streams`` option or if it's set to ``false``, then any change streams monitoring columns modified by transactions will capture the updates made within that transaction. """ class MutationGroup(proto.Message): r"""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. Attributes: mutations (MutableSequence[googlecloudsdk.generated_clients.gapic_clients.spanner_v1.types.Mutation]): Required. The mutations in this group. """ mutations: MutableSequence[mutation.Mutation] = proto.RepeatedField( proto.MESSAGE, number=1, message=mutation.Mutation, ) session: str = proto.Field( proto.STRING, number=1, ) request_options: 'RequestOptions' = proto.Field( proto.MESSAGE, number=3, message='RequestOptions', ) mutation_groups: MutableSequence[MutationGroup] = proto.RepeatedField( proto.MESSAGE, number=4, message=MutationGroup, ) exclude_txn_from_change_streams: bool = proto.Field( proto.BOOL, number=5, ) class BatchWriteResponse(proto.Message): r"""The result of applying a batch of mutations. Attributes: indexes (MutableSequence[int]): The mutation groups applied in this batch. The values index into the ``mutation_groups`` field in the corresponding ``BatchWriteRequest``. status (google.rpc.status_pb2.Status): An ``OK`` status indicates success. Any other status indicates a failure. commit_timestamp (google.protobuf.timestamp_pb2.Timestamp): The commit timestamp of the transaction that applied this batch. Present if ``status`` is ``OK``, absent otherwise. """ indexes: MutableSequence[int] = proto.RepeatedField( proto.INT32, number=1, ) status: status_pb2.Status = proto.Field( proto.MESSAGE, number=2, message=status_pb2.Status, ) commit_timestamp: timestamp_pb2.Timestamp = proto.Field( proto.MESSAGE, number=3, message=timestamp_pb2.Timestamp, ) __all__ = tuple(sorted(__protobuf__.manifest))