Package com.google.spanner.v1 (6.82.0)

GitHub Repository

This package is not the recommended entry point to using this client library!

For this library, we recommend using com.google.cloud.spanner for new applications.

Classes

Class Description
com.google.spanner.v1.BatchCreateSessionsRequest The request for BatchCreateSessions.
com.google.spanner.v1.BatchCreateSessionsRequest.Builder The request for BatchCreateSessions.
com.google.spanner.v1.BatchCreateSessionsResponse The response for BatchCreateSessions.
com.google.spanner.v1.BatchCreateSessionsResponse.Builder The response for BatchCreateSessions.
com.google.spanner.v1.BatchWriteRequest The request for BatchWrite.
com.google.spanner.v1.BatchWriteRequest.Builder The request for BatchWrite.
com.google.spanner.v1.BatchWriteRequest.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.
com.google.spanner.v1.BatchWriteRequest.MutationGroup.Builder 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.
com.google.spanner.v1.BatchWriteResponse The result of applying a batch of mutations.
com.google.spanner.v1.BatchWriteResponse.Builder The result of applying a batch of mutations.
com.google.spanner.v1.BeginTransactionRequest The request for BeginTransaction.
com.google.spanner.v1.BeginTransactionRequest.Builder The request for BeginTransaction.
com.google.spanner.v1.CommitRequest The request for Commit.
com.google.spanner.v1.CommitRequest.Builder The request for Commit.
com.google.spanner.v1.CommitResponse The response for Commit.
com.google.spanner.v1.CommitResponse.Builder The response for Commit.
com.google.spanner.v1.CommitResponse.CommitStats Additional statistics about a commit.
com.google.spanner.v1.CommitResponse.CommitStats.Builder Additional statistics about a commit.
com.google.spanner.v1.CommitResponseProto
com.google.spanner.v1.CreateSessionRequest The request for CreateSession.
com.google.spanner.v1.CreateSessionRequest.Builder The request for CreateSession.
com.google.spanner.v1.DatabaseName
com.google.spanner.v1.DatabaseName.Builder Builder for projects/{project}/instances/{instance}/databases/{database}.
com.google.spanner.v1.DeleteSessionRequest The request for DeleteSession.
com.google.spanner.v1.DeleteSessionRequest.Builder The request for DeleteSession.
com.google.spanner.v1.DirectedReadOptions The DirectedReadOptions can be used to indicate which replicas or regions should be used for non-transactional reads or queries.
com.google.spanner.v1.DirectedReadOptions.Builder The DirectedReadOptions can be used to indicate which replicas or regions should be used for non-transactional reads or queries.
com.google.spanner.v1.DirectedReadOptions.ExcludeReplicas An ExcludeReplicas contains a repeated set of ReplicaSelection that should be excluded from serving requests.
com.google.spanner.v1.DirectedReadOptions.ExcludeReplicas.Builder An ExcludeReplicas contains a repeated set of ReplicaSelection that should be excluded from serving requests.
com.google.spanner.v1.DirectedReadOptions.IncludeReplicas An IncludeReplicas contains a repeated set of ReplicaSelection which indicates the order in which replicas should be considered.
com.google.spanner.v1.DirectedReadOptions.IncludeReplicas.Builder An IncludeReplicas contains a repeated set of ReplicaSelection which indicates the order in which replicas should be considered.
com.google.spanner.v1.DirectedReadOptions.ReplicaSelection The directed read replica selector. Callers must provide one or more of the following fields for replica selection:
com.google.spanner.v1.DirectedReadOptions.ReplicaSelection.Builder The directed read replica selector. Callers must provide one or more of the following fields for replica selection:
com.google.spanner.v1.ExecuteBatchDmlRequest The request for ExecuteBatchDml.
com.google.spanner.v1.ExecuteBatchDmlRequest.Builder The request for ExecuteBatchDml.
com.google.spanner.v1.ExecuteBatchDmlRequest.Statement A single DML statement.
com.google.spanner.v1.ExecuteBatchDmlRequest.Statement.Builder A single DML statement.
com.google.spanner.v1.ExecuteBatchDmlResponse The response for ExecuteBatchDml. Contains a list of ResultSet messages, one for each DML
com.google.spanner.v1.ExecuteBatchDmlResponse.Builder The response for ExecuteBatchDml. Contains a list of ResultSet messages, one for each DML
com.google.spanner.v1.ExecuteSqlRequest The request for ExecuteSql and ExecuteStreamingSql.
com.google.spanner.v1.ExecuteSqlRequest.Builder The request for ExecuteSql and ExecuteStreamingSql.
com.google.spanner.v1.ExecuteSqlRequest.QueryOptions Query optimizer configuration.
com.google.spanner.v1.ExecuteSqlRequest.QueryOptions.Builder Query optimizer configuration.
com.google.spanner.v1.GetSessionRequest The request for GetSession.
com.google.spanner.v1.GetSessionRequest.Builder The request for GetSession.
com.google.spanner.v1.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
com.google.spanner.v1.KeyRange.Builder 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
com.google.spanner.v1.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.
com.google.spanner.v1.KeySet.Builder 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.
com.google.spanner.v1.KeysProto
com.google.spanner.v1.ListSessionsRequest The request for ListSessions.
com.google.spanner.v1.ListSessionsRequest.Builder The request for ListSessions.
com.google.spanner.v1.ListSessionsResponse The response for ListSessions.
com.google.spanner.v1.ListSessionsResponse.Builder The response for ListSessions.
com.google.spanner.v1.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
com.google.spanner.v1.MultiplexedSessionPrecommitToken.Builder 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
com.google.spanner.v1.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.
com.google.spanner.v1.Mutation.Builder 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.
com.google.spanner.v1.Mutation.Delete Arguments to delete operations.
com.google.spanner.v1.Mutation.Delete.Builder Arguments to delete operations.
com.google.spanner.v1.Mutation.Write Arguments to insert, update, insert_or_update, and replace operations.
com.google.spanner.v1.Mutation.Write.Builder Arguments to insert, update, insert_or_update, and replace operations.
com.google.spanner.v1.MutationProto
com.google.spanner.v1.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.
com.google.spanner.v1.PartialResultSet.Builder 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.
com.google.spanner.v1.Partition Information returned for each partition returned in a PartitionResponse.
com.google.spanner.v1.Partition.Builder Information returned for each partition returned in a PartitionResponse.
com.google.spanner.v1.PartitionOptions Options for a PartitionQueryRequest and PartitionReadRequest.
com.google.spanner.v1.PartitionOptions.Builder Options for a PartitionQueryRequest and PartitionReadRequest.
com.google.spanner.v1.PartitionQueryRequest The request for PartitionQuery
com.google.spanner.v1.PartitionQueryRequest.Builder The request for PartitionQuery
com.google.spanner.v1.PartitionReadRequest The request for PartitionRead
com.google.spanner.v1.PartitionReadRequest.Builder The request for PartitionRead
com.google.spanner.v1.PartitionResponse The response for PartitionQuery or PartitionRead
com.google.spanner.v1.PartitionResponse.Builder The response for PartitionQuery or PartitionRead
com.google.spanner.v1.PlanNode Node information for nodes appearing in a QueryPlan.plan_nodes.
com.google.spanner.v1.PlanNode.Builder Node information for nodes appearing in a QueryPlan.plan_nodes.
com.google.spanner.v1.PlanNode.ChildLink Metadata associated with a parent-child relationship appearing in a PlanNode.
com.google.spanner.v1.PlanNode.ChildLink.Builder Metadata associated with a parent-child relationship appearing in a PlanNode.
com.google.spanner.v1.PlanNode.ShortRepresentation Condensed representation of a node and its subtree. Only present for SCALAR PlanNode(s).
com.google.spanner.v1.PlanNode.ShortRepresentation.Builder Condensed representation of a node and its subtree. Only present for SCALAR PlanNode(s).
com.google.spanner.v1.QueryPlan Contains an ordered list of nodes appearing in the query plan.
com.google.spanner.v1.QueryPlan.Builder Contains an ordered list of nodes appearing in the query plan.
com.google.spanner.v1.QueryPlanProto
com.google.spanner.v1.ReadRequest The request for Read and StreamingRead.
com.google.spanner.v1.ReadRequest.Builder The request for Read and StreamingRead.
com.google.spanner.v1.RequestOptions Common request options for various APIs.
com.google.spanner.v1.RequestOptions.Builder Common request options for various APIs.
com.google.spanner.v1.ResultSet Results from Read or ExecuteSql.
com.google.spanner.v1.ResultSet.Builder Results from Read or ExecuteSql.
com.google.spanner.v1.ResultSetMetadata Metadata about a ResultSet or PartialResultSet.
com.google.spanner.v1.ResultSetMetadata.Builder Metadata about a ResultSet or PartialResultSet.
com.google.spanner.v1.ResultSetProto
com.google.spanner.v1.ResultSetStats Additional statistics about a ResultSet or PartialResultSet.
com.google.spanner.v1.ResultSetStats.Builder Additional statistics about a ResultSet or PartialResultSet.
com.google.spanner.v1.RollbackRequest The request for Rollback.
com.google.spanner.v1.RollbackRequest.Builder The request for Rollback.
com.google.spanner.v1.Session A session in the Cloud Spanner API.
com.google.spanner.v1.Session.Builder A session in the Cloud Spanner API.
com.google.spanner.v1.SessionName
com.google.spanner.v1.SessionName.Builder Builder for projects/{project}/instances/{instance}/databases/{database}/sessions/{session}.
com.google.spanner.v1.SpannerGrpc Cloud Spanner API The Cloud Spanner API can be used to manage sessions and execute transactions on data stored in Cloud Spanner databases.
com.google.spanner.v1.SpannerGrpc.SpannerImplBase Base class for the server implementation of the service Spanner. Cloud Spanner API
com.google.spanner.v1.SpannerProto
com.google.spanner.v1.StructType StructType defines the fields of a STRUCT type.
com.google.spanner.v1.StructType.Builder StructType defines the fields of a STRUCT type.
com.google.spanner.v1.StructType.Field Message representing a single field of a struct.
com.google.spanner.v1.StructType.Field.Builder Message representing a single field of a struct.
com.google.spanner.v1.Transaction A transaction.
com.google.spanner.v1.Transaction.Builder A transaction.
com.google.spanner.v1.TransactionOptions Transactions: Each session can have at most one active transaction at a time (note that
com.google.spanner.v1.TransactionOptions.Builder Transactions: Each session can have at most one active transaction at a time (note that
com.google.spanner.v1.TransactionOptions.PartitionedDml Message type to initiate a Partitioned DML transaction.
com.google.spanner.v1.TransactionOptions.PartitionedDml.Builder Message type to initiate a Partitioned DML transaction.
com.google.spanner.v1.TransactionOptions.ReadOnly Message type to initiate a read-only transaction.
com.google.spanner.v1.TransactionOptions.ReadOnly.Builder Message type to initiate a read-only transaction.
com.google.spanner.v1.TransactionOptions.ReadWrite Message type to initiate a read-write transaction. Currently this transaction type has no options.
com.google.spanner.v1.TransactionOptions.ReadWrite.Builder Message type to initiate a read-write transaction. Currently this transaction type has no options.
com.google.spanner.v1.TransactionProto
com.google.spanner.v1.TransactionSelector This message is used to select the transaction in which a Read or ExecuteSql call runs.
com.google.spanner.v1.TransactionSelector.Builder This message is used to select the transaction in which a Read or ExecuteSql call runs.
com.google.spanner.v1.Type Type indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query.
com.google.spanner.v1.Type.Builder Type indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query.
com.google.spanner.v1.TypeProto

Interfaces

Interface Description
com.google.spanner.v1.BatchCreateSessionsRequestOrBuilder
com.google.spanner.v1.BatchCreateSessionsResponseOrBuilder
com.google.spanner.v1.BatchWriteRequest.MutationGroupOrBuilder
com.google.spanner.v1.BatchWriteRequestOrBuilder
com.google.spanner.v1.BatchWriteResponseOrBuilder
com.google.spanner.v1.BeginTransactionRequestOrBuilder
com.google.spanner.v1.CommitRequestOrBuilder
com.google.spanner.v1.CommitResponse.CommitStatsOrBuilder
com.google.spanner.v1.CommitResponseOrBuilder
com.google.spanner.v1.CreateSessionRequestOrBuilder
com.google.spanner.v1.DeleteSessionRequestOrBuilder
com.google.spanner.v1.DirectedReadOptions.ExcludeReplicasOrBuilder
com.google.spanner.v1.DirectedReadOptions.IncludeReplicasOrBuilder
com.google.spanner.v1.DirectedReadOptions.ReplicaSelectionOrBuilder
com.google.spanner.v1.DirectedReadOptionsOrBuilder
com.google.spanner.v1.ExecuteBatchDmlRequest.StatementOrBuilder
com.google.spanner.v1.ExecuteBatchDmlRequestOrBuilder
com.google.spanner.v1.ExecuteBatchDmlResponseOrBuilder
com.google.spanner.v1.ExecuteSqlRequest.QueryOptionsOrBuilder
com.google.spanner.v1.ExecuteSqlRequestOrBuilder
com.google.spanner.v1.GetSessionRequestOrBuilder
com.google.spanner.v1.KeyRangeOrBuilder
com.google.spanner.v1.KeySetOrBuilder
com.google.spanner.v1.ListSessionsRequestOrBuilder
com.google.spanner.v1.ListSessionsResponseOrBuilder
com.google.spanner.v1.MultiplexedSessionPrecommitTokenOrBuilder
com.google.spanner.v1.Mutation.DeleteOrBuilder
com.google.spanner.v1.Mutation.WriteOrBuilder
com.google.spanner.v1.MutationOrBuilder
com.google.spanner.v1.PartialResultSetOrBuilder
com.google.spanner.v1.PartitionOptionsOrBuilder
com.google.spanner.v1.PartitionOrBuilder
com.google.spanner.v1.PartitionQueryRequestOrBuilder
com.google.spanner.v1.PartitionReadRequestOrBuilder
com.google.spanner.v1.PartitionResponseOrBuilder
com.google.spanner.v1.PlanNode.ChildLinkOrBuilder
com.google.spanner.v1.PlanNode.ShortRepresentationOrBuilder
com.google.spanner.v1.PlanNodeOrBuilder
com.google.spanner.v1.QueryPlanOrBuilder
com.google.spanner.v1.ReadRequestOrBuilder
com.google.spanner.v1.RequestOptionsOrBuilder
com.google.spanner.v1.ResultSetMetadataOrBuilder
com.google.spanner.v1.ResultSetOrBuilder
com.google.spanner.v1.ResultSetStatsOrBuilder
com.google.spanner.v1.RollbackRequestOrBuilder
com.google.spanner.v1.SessionOrBuilder
com.google.spanner.v1.SpannerGrpc.AsyncService Cloud Spanner API The Cloud Spanner API can be used to manage sessions and execute transactions on data stored in Cloud Spanner databases.
com.google.spanner.v1.StructType.FieldOrBuilder
com.google.spanner.v1.StructTypeOrBuilder
com.google.spanner.v1.TransactionOptions.PartitionedDmlOrBuilder
com.google.spanner.v1.TransactionOptions.ReadOnlyOrBuilder
com.google.spanner.v1.TransactionOptions.ReadWriteOrBuilder
com.google.spanner.v1.TransactionOptionsOrBuilder
com.google.spanner.v1.TransactionOrBuilder
com.google.spanner.v1.TransactionSelectorOrBuilder
com.google.spanner.v1.TypeOrBuilder

Enums

Enum Description
com.google.spanner.v1.CommitRequest.TransactionCase
com.google.spanner.v1.CommitResponse.MultiplexedSessionRetryCase
com.google.spanner.v1.DirectedReadOptions.ReplicaSelection.Type Indicates the type of replica.
com.google.spanner.v1.DirectedReadOptions.ReplicasCase
com.google.spanner.v1.ExecuteSqlRequest.QueryMode Mode in which the statement must be processed.
com.google.spanner.v1.KeyRange.EndKeyTypeCase
com.google.spanner.v1.KeyRange.StartKeyTypeCase
com.google.spanner.v1.Mutation.OperationCase
com.google.spanner.v1.PlanNode.Kind The kind of PlanNode. Distinguishes between the two different kinds of nodes that can appear in a query plan.
com.google.spanner.v1.ReadRequest.LockHint A lock hint mechanism for reads done within a transaction.
com.google.spanner.v1.ReadRequest.OrderBy An option to control the order in which rows are returned from a read.
com.google.spanner.v1.RequestOptions.Priority The relative priority for requests. Note that priority is not applicable for BeginTransaction.
com.google.spanner.v1.ResultSetStats.RowCountCase
com.google.spanner.v1.TransactionOptions.ModeCase
com.google.spanner.v1.TransactionOptions.ReadOnly.TimestampBoundCase
com.google.spanner.v1.TransactionOptions.ReadWrite.ReadLockMode ReadLockMode is used to set the read lock mode for read-write transactions.
com.google.spanner.v1.TransactionSelector.SelectorCase
com.google.spanner.v1.TypeAnnotationCode TypeAnnotationCode is used as a part of Type to disambiguate SQL types that should be used for a given Cloud Spanner value. Disambiguation is needed because the same Cloud Spanner type can be mapped to
com.google.spanner.v1.TypeCode TypeCode is used as part of Type to indicate the type of a Cloud Spanner value.