Package com.google.spanner.v1 (6.87.0)

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

ClassDescription
com.google.spanner.v1.BatchCreateSessionsRequestThe request for BatchCreateSessions.
com.google.spanner.v1.BatchCreateSessionsRequest.BuilderThe request for BatchCreateSessions.
com.google.spanner.v1.BatchCreateSessionsResponseThe response for BatchCreateSessions.
com.google.spanner.v1.BatchCreateSessionsResponse.BuilderThe response for BatchCreateSessions.
com.google.spanner.v1.BatchWriteRequestThe request for BatchWrite.
com.google.spanner.v1.BatchWriteRequest.BuilderThe request for BatchWrite.
com.google.spanner.v1.BatchWriteRequest.MutationGroupA 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.BuilderA 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.BatchWriteResponseThe result of applying a batch of mutations.
com.google.spanner.v1.BatchWriteResponse.BuilderThe result of applying a batch of mutations.
com.google.spanner.v1.BeginTransactionRequestThe request for BeginTransaction.
com.google.spanner.v1.BeginTransactionRequest.BuilderThe request for BeginTransaction.
com.google.spanner.v1.CommitRequestThe request for Commit.
com.google.spanner.v1.CommitRequest.BuilderThe request for Commit.
com.google.spanner.v1.CommitResponseThe response for Commit.
com.google.spanner.v1.CommitResponse.BuilderThe response for Commit.
com.google.spanner.v1.CommitResponse.CommitStatsAdditional statistics about a commit.
com.google.spanner.v1.CommitResponse.CommitStats.BuilderAdditional statistics about a commit.
com.google.spanner.v1.CommitResponseProto
com.google.spanner.v1.CreateSessionRequestThe request for CreateSession.
com.google.spanner.v1.CreateSessionRequest.BuilderThe request for CreateSession.
com.google.spanner.v1.DatabaseName
com.google.spanner.v1.DatabaseName.BuilderBuilder for projects/{project}/instances/{instance}/databases/{database}.
com.google.spanner.v1.DeleteSessionRequestThe request for DeleteSession.
com.google.spanner.v1.DeleteSessionRequest.BuilderThe request for DeleteSession.
com.google.spanner.v1.DirectedReadOptionsThe DirectedReadOptions can be used to indicate which replicas or regions should be used for non-transactional reads or queries.
com.google.spanner.v1.DirectedReadOptions.BuilderThe DirectedReadOptions can be used to indicate which replicas or regions should be used for non-transactional reads or queries.
com.google.spanner.v1.DirectedReadOptions.ExcludeReplicasAn ExcludeReplicas contains a repeated set of ReplicaSelection that should be excluded from serving requests.
com.google.spanner.v1.DirectedReadOptions.ExcludeReplicas.BuilderAn ExcludeReplicas contains a repeated set of ReplicaSelection that should be excluded from serving requests.
com.google.spanner.v1.DirectedReadOptions.IncludeReplicasAn IncludeReplicas contains a repeated set of ReplicaSelection which indicates the order in which replicas should be considered.
com.google.spanner.v1.DirectedReadOptions.IncludeReplicas.BuilderAn IncludeReplicas contains a repeated set of ReplicaSelection which indicates the order in which replicas should be considered.
com.google.spanner.v1.DirectedReadOptions.ReplicaSelectionThe directed read replica selector. Callers must provide one or more of the following fields for replica selection:
com.google.spanner.v1.DirectedReadOptions.ReplicaSelection.BuilderThe directed read replica selector. Callers must provide one or more of the following fields for replica selection:
com.google.spanner.v1.ExecuteBatchDmlRequestThe request for ExecuteBatchDml.
com.google.spanner.v1.ExecuteBatchDmlRequest.BuilderThe request for ExecuteBatchDml.
com.google.spanner.v1.ExecuteBatchDmlRequest.StatementA single DML statement.
com.google.spanner.v1.ExecuteBatchDmlRequest.Statement.BuilderA single DML statement.
com.google.spanner.v1.ExecuteBatchDmlResponseThe response for ExecuteBatchDml. Contains a list of ResultSet messages, one for each DML
com.google.spanner.v1.ExecuteBatchDmlResponse.BuilderThe response for ExecuteBatchDml. Contains a list of ResultSet messages, one for each DML
com.google.spanner.v1.ExecuteSqlRequestThe request for ExecuteSql and ExecuteSql.
com.google.spanner.v1.ExecuteSqlRequest.BuilderThe request for ExecuteSql and ExecuteSql.
com.google.spanner.v1.ExecuteSqlRequest.QueryOptionsQuery optimizer configuration.
com.google.spanner.v1.ExecuteSqlRequest.QueryOptions.BuilderQuery optimizer configuration.
com.google.spanner.v1.GetSessionRequestThe request for GetSession.
com.google.spanner.v1.GetSessionRequest.BuilderThe request for GetSession.
com.google.spanner.v1.KeyRangeKeyRange 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.BuilderKeyRange 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.KeySetKeySet 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.BuilderKeySet 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.ListSessionsRequestThe request for ListSessions.
com.google.spanner.v1.ListSessionsRequest.BuilderThe request for ListSessions.
com.google.spanner.v1.ListSessionsResponseThe response for ListSessions.
com.google.spanner.v1.ListSessionsResponse.BuilderThe response for ListSessions.
com.google.spanner.v1.MultiplexedSessionPrecommitTokenWhen 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.BuilderWhen 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.MutationA 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.BuilderA 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.DeleteArguments to delete operations.
com.google.spanner.v1.Mutation.Delete.BuilderArguments to delete operations.
com.google.spanner.v1.Mutation.WriteArguments to insert, update, insert_or_update, and replace operations.
com.google.spanner.v1.Mutation.Write.BuilderArguments to insert, update, insert_or_update, and replace operations.
com.google.spanner.v1.MutationProto
com.google.spanner.v1.PartialResultSetPartial results from a read or SQL query. 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.BuilderPartial results from a read or SQL query. 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.PartitionInformation returned for each partition returned in a PartitionResponse.
com.google.spanner.v1.Partition.BuilderInformation returned for each partition returned in a PartitionResponse.
com.google.spanner.v1.PartitionOptionsOptions for a PartitionQueryRequest and PartitionReadRequest.
com.google.spanner.v1.PartitionOptions.BuilderOptions for a PartitionQueryRequest and PartitionReadRequest.
com.google.spanner.v1.PartitionQueryRequestThe request for PartitionQuery
com.google.spanner.v1.PartitionQueryRequest.BuilderThe request for PartitionQuery
com.google.spanner.v1.PartitionReadRequestThe request for PartitionRead
com.google.spanner.v1.PartitionReadRequest.BuilderThe request for PartitionRead
com.google.spanner.v1.PartitionResponseThe response for PartitionQuery or PartitionRead
com.google.spanner.v1.PartitionResponse.BuilderThe response for PartitionQuery or PartitionRead
com.google.spanner.v1.PlanNodeNode information for nodes appearing in a QueryPlan.plan_nodes.
com.google.spanner.v1.PlanNode.BuilderNode information for nodes appearing in a QueryPlan.plan_nodes.
com.google.spanner.v1.PlanNode.ChildLinkMetadata associated with a parent-child relationship appearing in a PlanNode.
com.google.spanner.v1.PlanNode.ChildLink.BuilderMetadata associated with a parent-child relationship appearing in a PlanNode.
com.google.spanner.v1.PlanNode.ShortRepresentationCondensed representation of a node and its subtree. Only present for SCALAR PlanNode(s).
com.google.spanner.v1.PlanNode.ShortRepresentation.BuilderCondensed representation of a node and its subtree. Only present for SCALAR PlanNode(s).
com.google.spanner.v1.QueryPlanContains an ordered list of nodes appearing in the query plan.
com.google.spanner.v1.QueryPlan.BuilderContains an ordered list of nodes appearing in the query plan.
com.google.spanner.v1.QueryPlanProto
com.google.spanner.v1.ReadRequestThe request for Read and Read.
com.google.spanner.v1.ReadRequest.BuilderThe request for Read and Read.
com.google.spanner.v1.RequestOptionsCommon request options for various APIs.
com.google.spanner.v1.RequestOptions.BuilderCommon request options for various APIs.
com.google.spanner.v1.ResultSetResults from Read or ExecuteSql.
com.google.spanner.v1.ResultSet.BuilderResults from Read or ExecuteSql.
com.google.spanner.v1.ResultSetMetadataMetadata about a ResultSet or PartialResultSet.
com.google.spanner.v1.ResultSetMetadata.BuilderMetadata about a ResultSet or PartialResultSet.
com.google.spanner.v1.ResultSetProto
com.google.spanner.v1.ResultSetStatsAdditional statistics about a ResultSet or PartialResultSet.
com.google.spanner.v1.ResultSetStats.BuilderAdditional statistics about a ResultSet or PartialResultSet.
com.google.spanner.v1.RollbackRequestThe request for Rollback.
com.google.spanner.v1.RollbackRequest.BuilderThe request for Rollback.
com.google.spanner.v1.SessionA session in the Cloud Spanner API.
com.google.spanner.v1.Session.BuilderA session in the Cloud Spanner API.
com.google.spanner.v1.SessionName
com.google.spanner.v1.SessionName.BuilderBuilder for projects/{project}/instances/{instance}/databases/{database}/sessions/{session}.
com.google.spanner.v1.SpannerGrpcCloud 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.SpannerImplBaseBase class for the server implementation of the service Spanner. Cloud Spanner API
com.google.spanner.v1.SpannerProto
com.google.spanner.v1.StructTypeStructType defines the fields of a STRUCT type.
com.google.spanner.v1.StructType.BuilderStructType defines the fields of a STRUCT type.
com.google.spanner.v1.StructType.FieldMessage representing a single field of a struct.
com.google.spanner.v1.StructType.Field.BuilderMessage representing a single field of a struct.
com.google.spanner.v1.TransactionA transaction.
com.google.spanner.v1.Transaction.BuilderA transaction.
com.google.spanner.v1.TransactionOptionsTransactions: Each session can have at most one active transaction at a time (note that
com.google.spanner.v1.TransactionOptions.BuilderTransactions: Each session can have at most one active transaction at a time (note that
com.google.spanner.v1.TransactionOptions.PartitionedDmlMessage type to initiate a Partitioned DML transaction.
com.google.spanner.v1.TransactionOptions.PartitionedDml.BuilderMessage type to initiate a Partitioned DML transaction.
com.google.spanner.v1.TransactionOptions.ReadOnlyMessage type to initiate a read-only transaction.
com.google.spanner.v1.TransactionOptions.ReadOnly.BuilderMessage type to initiate a read-only transaction.
com.google.spanner.v1.TransactionOptions.ReadWriteMessage type to initiate a read-write transaction. Currently this transaction type has no options.
com.google.spanner.v1.TransactionOptions.ReadWrite.BuilderMessage type to initiate a read-write transaction. Currently this transaction type has no options.
com.google.spanner.v1.TransactionProto
com.google.spanner.v1.TransactionSelectorThis message is used to select the transaction in which a Read or ExecuteSql call runs.
com.google.spanner.v1.TransactionSelector.BuilderThis message is used to select the transaction in which a Read or ExecuteSql call runs.
com.google.spanner.v1.TypeType 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.BuilderType 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

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

EnumDescription
com.google.spanner.v1.CommitRequest.TransactionCase
com.google.spanner.v1.CommitResponse.MultiplexedSessionRetryCase
com.google.spanner.v1.DirectedReadOptions.ReplicaSelection.TypeIndicates the type of replica.
com.google.spanner.v1.DirectedReadOptions.ReplicasCase
com.google.spanner.v1.ExecuteSqlRequest.QueryModeMode 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.KindThe kind of PlanNode. Distinguishes between the two different kinds of nodes that can appear in a query plan.
com.google.spanner.v1.ReadRequest.LockHintA lock hint mechanism for reads done within a transaction.
com.google.spanner.v1.ReadRequest.OrderByAn option to control the order in which rows are returned from a read.
com.google.spanner.v1.RequestOptions.PriorityThe 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.ReadLockModeReadLockMode is used to set the read lock mode for read-write transactions.
com.google.spanner.v1.TransactionSelector.SelectorCase
com.google.spanner.v1.TypeAnnotationCodeTypeAnnotationCode 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.TypeCodeTypeCode is used as part of Type to indicate the type of a Cloud Spanner value.