Package com.google.spanner.v1

Class PartitionReadRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.v1.PartitionReadRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PartitionReadRequestOrBuilder, Serializable
public final class PartitionReadRequest extends com.google.protobuf.GeneratedMessageV3 implements PartitionReadRequestOrBuilder
 The request for [PartitionRead][google.spanner.v1.Spanner.PartitionRead]
Protobuf type google.spanner.v1.PartitionReadRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    PartitionReadRequest.Builder
    The request for [PartitionRead][google.spanner.v1.Spanner.PartitionRead]

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    COLUMNS_FIELD_NUMBER
     
    static final int
    INDEX_FIELD_NUMBER
     
    static final int
    KEY_SET_FIELD_NUMBER
     
    static final int
    PARTITION_OPTIONS_FIELD_NUMBER
     
    static final int
    SESSION_FIELD_NUMBER
     
    static final int
    TABLE_FIELD_NUMBER
     
    static final int
    TRANSACTION_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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.
    com.google.protobuf.ProtocolStringList
    getColumnsList()
    The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
    static PartitionReadRequest
    getDefaultInstance()
     
    PartitionReadRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.Parser<PartitionReadRequest>
    getParserForType()
     
    PartitionOptions
    getPartitionOptions()
    Additional options that affect how many partitions are created.
    PartitionOptionsOrBuilder
    getPartitionOptionsOrBuilder()
    Additional options that affect how many partitions are created.
    int
    getSerializedSize()
     
    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.
    int
    hashCode()
     
    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.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static PartitionReadRequest.Builder
    newBuilder()
     
    static PartitionReadRequest.Builder
    newBuilder(PartitionReadRequest prototype)
     
    PartitionReadRequest.Builder
    newBuilderForType()
     
    protected PartitionReadRequest.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static PartitionReadRequest
    parseDelimitedFrom(InputStream input)
     
    static PartitionReadRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PartitionReadRequest
    parseFrom(byte[] data)
     
    static PartitionReadRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PartitionReadRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static PartitionReadRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PartitionReadRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static PartitionReadRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PartitionReadRequest
    parseFrom(InputStream input)
     
    static PartitionReadRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PartitionReadRequest
    parseFrom(ByteBuffer data)
     
    static PartitionReadRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<PartitionReadRequest>
    parser()
     
    PartitionReadRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getSession

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

    • getSessionBytes

      public 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) = { ... }
      Specified by:
      getSessionBytes in interface PartitionReadRequestOrBuilder
      Returns:
      The bytes for session.

    • hasTransaction

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

    • getTransaction

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

    • getTransactionOrBuilder

      public TransactionSelectorOrBuilder getTransactionOrBuilder()
       Read only snapshot transactions are supported, read/write and single use
 transactions are not.
      .google.spanner.v1.TransactionSelector transaction = 2;
      Specified by:
      getTransactionOrBuilder in interface PartitionReadRequestOrBuilder

    • getTable

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

    • getTableBytes

      public 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];
      Specified by:
      getTableBytes in interface PartitionReadRequestOrBuilder
      Returns:
      The bytes for table.

    • getIndex

      public 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;
      Specified by:
      getIndex in interface PartitionReadRequestOrBuilder
      Returns:
      The index.

    • getIndexBytes

      public 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;
      Specified by:
      getIndexBytes in interface PartitionReadRequestOrBuilder
      Returns:
      The bytes for index.

    • getColumnsList

      public com.google.protobuf.ProtocolStringList getColumnsList()
       The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be
 returned for each row matching this request.
      repeated string columns = 5;
      Specified by:
      getColumnsList in interface PartitionReadRequestOrBuilder
      Returns:
      A list containing the columns.

    • getColumnsCount

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

    • getColumns

      public 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;
      Specified by:
      getColumns in interface PartitionReadRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The columns at the given index.

    • getColumnsBytes

      public 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;
      Specified by:
      getColumnsBytes in interface PartitionReadRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the columns at the given index.

    • hasKeySet

      public 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];
      Specified by:
      hasKeySet in interface PartitionReadRequestOrBuilder
      Returns:
      Whether the keySet field is set.

    • getKeySet

      public 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];
      Specified by:
      getKeySet in interface PartitionReadRequestOrBuilder
      Returns:
      The keySet.

    • getKeySetOrBuilder

      public 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];
      Specified by:
      getKeySetOrBuilder in interface PartitionReadRequestOrBuilder

    • hasPartitionOptions

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

    • getPartitionOptions

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

    • getPartitionOptionsOrBuilder

      public PartitionOptionsOrBuilder getPartitionOptionsOrBuilder()
       Additional options that affect how many partitions are created.
      .google.spanner.v1.PartitionOptions partition_options = 9;
      Specified by:
      getPartitionOptionsOrBuilder in interface PartitionReadRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static PartitionReadRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PartitionReadRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PartitionReadRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PartitionReadRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PartitionReadRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PartitionReadRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static PartitionReadRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PartitionReadRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PartitionReadRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PartitionReadRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PartitionReadRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static PartitionReadRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public PartitionReadRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static PartitionReadRequest.Builder newBuilder()

    • newBuilder

      public static PartitionReadRequest.Builder newBuilder(PartitionReadRequest prototype)

    • toBuilder

      public PartitionReadRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected PartitionReadRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static PartitionReadRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<PartitionReadRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<PartitionReadRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public PartitionReadRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder