Package com.google.spanner.v1

Interface ReadRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ReadRequest, ReadRequest.Builder
public interface ReadRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getSession

      String getSession()
       Required. The session in which the read should be performed.
      string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The session.

    • getSessionBytes

      com.google.protobuf.ByteString getSessionBytes()
       Required. The session in which the read should be performed.
      string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for session.

    • hasTransaction

      boolean hasTransaction()
       The transaction to use. If none is provided, the default is a
 temporary read-only transaction with strong concurrency.
      .google.spanner.v1.TransactionSelector transaction = 2;
      Returns:
      Whether the transaction field is set.

    • getTransaction

      TransactionSelector getTransaction()
       The transaction to use. If none is provided, the default is a
 temporary read-only transaction with strong concurrency.
      .google.spanner.v1.TransactionSelector transaction = 2;
      Returns:
      The transaction.

    • getTransactionOrBuilder

      TransactionSelectorOrBuilder getTransactionOrBuilder()
       The transaction to use. If none is provided, the default is a
 temporary read-only transaction with strong concurrency.
      .google.spanner.v1.TransactionSelector transaction = 2;

    • getTable

      String getTable()
       Required. The name of the table in the database to be read.
      string table = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The table.

    • getTableBytes

      com.google.protobuf.ByteString getTableBytes()
       Required. The name of the table in the database to be read.
      string table = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for table.

    • getIndex

      String getIndex()
       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.
      string index = 4;
      Returns:
      The index.

    • getIndexBytes

      com.google.protobuf.ByteString getIndexBytes()
       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.
      string index = 4;
      Returns:
      The bytes for index.

    • getColumnsList

      List<String> getColumnsList()
       Required. The columns of [table][google.spanner.v1.ReadRequest.table] to be
 returned for each row matching this request.
      repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      A list containing the columns.

    • getColumnsCount

      int getColumnsCount()
       Required. The columns of [table][google.spanner.v1.ReadRequest.table] to be
 returned for each row matching this request.
      repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The count of columns.

    • getColumns

      String getColumns(int index)
       Required. The columns of [table][google.spanner.v1.ReadRequest.table] to be
 returned for each row matching this request.
      repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      index - The index of the element to return.
      Returns:
      The columns at the given index.

    • getColumnsBytes

      com.google.protobuf.ByteString getColumnsBytes(int index)
       Required. The columns of [table][google.spanner.v1.ReadRequest.table] to be
 returned for each row matching this request.
      repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the columns at the given index.

    • hasKeySet

      boolean hasKeySet()
       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 is
 not empty, rows will be yielded in an unspecified order.

 It is not an error for the `key_set` to name rows that do not
 exist in the database. Read yields nothing for nonexistent rows.
      .google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the keySet field is set.

    • getKeySet

      KeySet getKeySet()
       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 is
 not empty, rows will be yielded in an unspecified order.

 It is not an error for the `key_set` to name rows that do not
 exist in the database. Read yields nothing for nonexistent rows.
      .google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The keySet.

    • getKeySetOrBuilder

      KeySetOrBuilder getKeySetOrBuilder()
       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 is
 not empty, rows will be yielded in an unspecified order.

 It is not an error for the `key_set` to name rows that do not
 exist in the database. Read yields nothing for nonexistent rows.
      .google.spanner.v1.KeySet key_set = 6 [(.google.api.field_behavior) = REQUIRED];

    • getLimit

      long getLimit()
       If greater than zero, only the first `limit` rows are yielded. If `limit`
 is zero, the default is no limit. A limit cannot be specified if
 `partition_token` is set.
      int64 limit = 8;
      Returns:
      The limit.

    • getResumeToken

      com.google.protobuf.ByteString getResumeToken()
       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.
      bytes resume_token = 9;
      Returns:
      The resumeToken.

    • getPartitionToken

      com.google.protobuf.ByteString getPartitionToken()
       If present, results will be 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.
      bytes partition_token = 10;
      Returns:
      The partitionToken.

    • hasRequestOptions

      boolean hasRequestOptions()
       Common options for this request.
      .google.spanner.v1.RequestOptions request_options = 11;
      Returns:
      Whether the requestOptions field is set.

    • getRequestOptions

      RequestOptions getRequestOptions()
       Common options for this request.
      .google.spanner.v1.RequestOptions request_options = 11;
      Returns:
      The requestOptions.

    • getRequestOptionsOrBuilder

      RequestOptionsOrBuilder getRequestOptionsOrBuilder()
       Common options for this request.
      .google.spanner.v1.RequestOptions request_options = 11;

    • hasDirectedReadOptions

      boolean hasDirectedReadOptions()
       Directed read options for this request.
      .google.spanner.v1.DirectedReadOptions directed_read_options = 14;
      Returns:
      Whether the directedReadOptions field is set.

    • getDirectedReadOptions

      DirectedReadOptions getDirectedReadOptions()
       Directed read options for this request.
      .google.spanner.v1.DirectedReadOptions directed_read_options = 14;
      Returns:
      The directedReadOptions.

    • getDirectedReadOptionsOrBuilder

      DirectedReadOptionsOrBuilder getDirectedReadOptionsOrBuilder()
       Directed read options for this request.
      .google.spanner.v1.DirectedReadOptions directed_read_options = 14;

    • getDataBoostEnabled

      boolean getDataBoostEnabled()
       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 does not set
 `partition_token`, the API returns an `INVALID_ARGUMENT` error.
      bool data_boost_enabled = 15;
      Returns:
      The dataBoostEnabled.