Class PartitionReadRequest (6.25.1)
6.116.0 (latest)
6.111.1
6.108.0
6.107.0
6.103.0
6.102.1
6.101.1
6.100.0
6.99.0
6.98.1
6.97.1
6.96.1
6.95.1
6.94.0
6.93.0
6.89.0
6.88.0
6.87.0
6.86.0
6.85.0
6.83.0
6.82.0
6.80.1
6.79.0
6.77.0
6.74.1
6.72.0
6.71.0
6.69.0
6.68.0
6.66.0
6.65.1
6.62.0
6.60.0
6.58.0
6.57.0
6.56.0
6.55.0
6.54.0
6.53.0
6.52.1
6.51.0
6.50.1
6.49.0
6.25.1
6.24.0
6.23.4
6.22.0
6.21.2
6.20.0
6.19.1
6.18.0
6.17.4
6.14.1
public final class PartitionReadRequest extends GeneratedMessageV3 implements PartitionReadRequestOrBuilder
The request for PartitionRead
Protobuf type google.spanner.v1.PartitionReadRequest
Static Fields
COLUMNS_FIELD_NUMBER
public static final int COLUMNS_FIELD_NUMBER
Field Value
Type Description
int
INDEX_FIELD_NUMBER
public static final int INDEX_FIELD_NUMBER
Field Value
Type Description
int
KEY_SET_FIELD_NUMBER
public static final int KEY_SET_FIELD_NUMBER
Field Value
Type Description
int
PARTITION_OPTIONS_FIELD_NUMBER
public static final int PARTITION_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int
SESSION_FIELD_NUMBER
public static final int SESSION_FIELD_NUMBER
Field Value
Type Description
int
TABLE_FIELD_NUMBER
public static final int TABLE_FIELD_NUMBER
Field Value
Type Description
int
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static PartitionReadRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static PartitionReadRequest . Builder newBuilder ()
newBuilder(PartitionReadRequest prototype)
public static PartitionReadRequest . Builder newBuilder ( PartitionReadRequest prototype )
public static PartitionReadRequest parseDelimitedFrom ( InputStream input )
public static PartitionReadRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static PartitionReadRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PartitionReadRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static PartitionReadRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PartitionReadRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static PartitionReadRequest parseFrom ( CodedInputStream input )
public static PartitionReadRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static PartitionReadRequest parseFrom ( InputStream input )
public static PartitionReadRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static PartitionReadRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PartitionReadRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<PartitionReadRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getColumns(int index)
public String getColumns ( int index )
The columns of table to be returned for each row matching
this request.
repeated string columns = 5;
Parameter
Name Description
indexint The index of the element to return.
Returns
Type Description
String The columns at the given index.
getColumnsBytes(int index)
public ByteString getColumnsBytes ( int index )
The columns of table to be returned for each row matching
this request.
repeated string columns = 5;
Parameter
Name Description
indexint The index of the value to return.
Returns
Type Description
ByteString The bytes of the columns at the given index.
getColumnsCount()
public int getColumnsCount ()
The columns of table to be returned for each row matching
this request.
repeated string columns = 5;
Returns
Type Description
int The count of columns.
getColumnsList()
public ProtocolStringList getColumnsList ()
The columns of table to be returned for each row matching
this request.
repeated string columns = 5;
getDefaultInstanceForType()
public PartitionReadRequest getDefaultInstanceForType ()
getIndex()
If non-empty, the name of an index on table . This index is
used instead of the table primary key when interpreting key_set
and sorting result rows. See key_set for further information.
string index = 4;
Returns
Type Description
String The index.
getIndexBytes()
public ByteString getIndexBytes ()
If non-empty, the name of an index on table . This index is
used instead of the table primary key when interpreting key_set
and sorting result rows. See key_set for further information.
string index = 4;
Returns
Type Description
ByteString The bytes for index.
getKeySet()
public KeySet getKeySet ()
Required. key_set identifies the rows to be yielded. key_set names the
primary keys of the rows in table to be yielded, unless index
is present. If index is present, then key_set instead names
index keys in 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
Type Description
KeySet 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 to be yielded, unless index
is present. If index is present, then key_set instead names
index keys in 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];
getParserForType()
public Parser<PartitionReadRequest> getParserForType ()
Overrides
getPartitionOptions()
public PartitionOptions getPartitionOptions ()
Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 9;
getPartitionOptionsOrBuilder()
public PartitionOptionsOrBuilder getPartitionOptionsOrBuilder ()
Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 9;
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getSession()
public String getSession ()
Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type Description
String The session.
getSessionBytes()
public ByteString getSessionBytes ()
Required. The session used to create the partitions.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type Description
ByteString The bytes for session.
getTable()
Required. The name of the table in the database to be read.
string table = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The table.
getTableBytes()
public ByteString getTableBytes ()
Required. The name of the table in the database to be read.
string table = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for table.
getTransaction()
public TransactionSelector getTransaction ()
Read only snapshot transactions are supported, read/write and single use
transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
getTransactionOrBuilder()
public TransactionSelectorOrBuilder getTransactionOrBuilder ()
Read only snapshot transactions are supported, read/write and single use
transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Overrides
hasKeySet()
public boolean hasKeySet ()
Required. key_set identifies the rows to be yielded. key_set names the
primary keys of the rows in table to be yielded, unless index
is present. If index is present, then key_set instead names
index keys in 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
Type Description
boolean Whether the keySet field is set.
hasPartitionOptions()
public boolean hasPartitionOptions ()
Additional options that affect how many partitions are created.
.google.spanner.v1.PartitionOptions partition_options = 9;
Returns
Type Description
boolean Whether the partitionOptions field is set.
hasTransaction()
public boolean hasTransaction ()
Read only snapshot transactions are supported, read/write and single use
transactions are not.
.google.spanner.v1.TransactionSelector transaction = 2;
Returns
Type Description
boolean Whether the transaction field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public PartitionReadRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PartitionReadRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public PartitionReadRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-04-26 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-04-26 UTC."],[],[]]
