Package com.google.spanner.v1

Interface PartitionReadRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    PartitionReadRequest, PartitionReadRequest.Builder
    public interface PartitionReadRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getColumns​(int index)
      The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
      com.google.protobuf.ByteString getColumnsBytes​(int index)
      The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
      int getColumnsCount()
      The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
      List<String> getColumnsList()
      The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
      String getIndex()
      If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table].
      com.google.protobuf.ByteString getIndexBytes()
      If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table].
      KeySet getKeySet()
      Required.
      KeySetOrBuilder getKeySetOrBuilder()
      Required.
      PartitionOptions getPartitionOptions()
      Additional options that affect how many partitions are created.
      PartitionOptionsOrBuilder getPartitionOptionsOrBuilder()
      Additional options that affect how many partitions are created.
      String getSession()
      Required.
      com.google.protobuf.ByteString getSessionBytes()
      Required.
      String getTable()
      Required.
      com.google.protobuf.ByteString getTableBytes()
      Required.
      TransactionSelector getTransaction()
      Read only snapshot transactions are supported, read/write and single use transactions are not.
      TransactionSelectorOrBuilder getTransactionOrBuilder()
      Read only snapshot transactions are supported, read/write and single use transactions are not.
      boolean hasKeySet()
      Required.
      boolean hasPartitionOptions()
      Additional options that affect how many partitions are created.
      boolean hasTransaction()
      Read only snapshot transactions are supported, read/write and single use transactions are not.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getSession

        String getSession()
         Required. The session used to create the partitions.
        string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The session.

      • getSessionBytes

        com.google.protobuf.ByteString getSessionBytes()
         Required. The session used to create the partitions.
        string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for session.

      • hasTransaction

        boolean hasTransaction()
         Read only snapshot transactions are supported, read/write and single use
 transactions are not.
        .google.spanner.v1.TransactionSelector transaction = 2;
        Returns:
        Whether the transaction field is set.

      • getTransaction

        TransactionSelector getTransaction()
         Read only snapshot transactions are supported, read/write and single use
 transactions are not.
        .google.spanner.v1.TransactionSelector transaction = 2;
        Returns:
        The transaction.

      • getTransactionOrBuilder

        TransactionSelectorOrBuilder getTransactionOrBuilder()
         Read only snapshot transactions are supported, read/write and single use
 transactions are not.
        .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.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.
        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.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.
        string index = 4;
        Returns:
        The bytes for index.

      • getColumnsList

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

      • getColumnsCount

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

      • getColumns

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

      • getColumnsBytes

        com.google.protobuf.ByteString getColumnsBytes​(int index)
         The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching
 this request.
        repeated string columns = 5;
        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.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 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.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 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.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 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];

      • hasPartitionOptions

        boolean hasPartitionOptions()
         Additional options that affect how many partitions are created.
        .google.spanner.v1.PartitionOptions partition_options = 9;
        Returns:
        Whether the partitionOptions field is set.

      • getPartitionOptions

        PartitionOptions getPartitionOptions()
         Additional options that affect how many partitions are created.
        .google.spanner.v1.PartitionOptions partition_options = 9;
        Returns:
        The partitionOptions.

      • getPartitionOptionsOrBuilder

        PartitionOptionsOrBuilder getPartitionOptionsOrBuilder()
         Additional options that affect how many partitions are created.
        .google.spanner.v1.PartitionOptions partition_options = 9;