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
INDEX_FIELD_NUMBER
public static final int INDEX_FIELD_NUMBER
Field Value
KEY_SET_FIELD_NUMBER
public static final int KEY_SET_FIELD_NUMBER
Field Value
PARTITION_OPTIONS_FIELD_NUMBER
public static final int PARTITION_OPTIONS_FIELD_NUMBER
Field Value
SESSION_FIELD_NUMBER
public static final int SESSION_FIELD_NUMBER
Field Value
TABLE_FIELD_NUMBER
public static final int TABLE_FIELD_NUMBER
Field Value
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static PartitionReadRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static PartitionReadRequest.Builder newBuilder()
Returns
newBuilder(PartitionReadRequest prototype)
public static PartitionReadRequest.Builder newBuilder(PartitionReadRequest prototype)
Parameter
Returns
public static PartitionReadRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static PartitionReadRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static PartitionReadRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PartitionReadRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static PartitionReadRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PartitionReadRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PartitionReadRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static PartitionReadRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PartitionReadRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static PartitionReadRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static PartitionReadRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PartitionReadRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<PartitionReadRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
| Name | Description |
| index | int
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;
| Name | Description |
| index | int
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;
| 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()
Returns
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;
| 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;
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];
| 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()
Returns
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
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) = { ... }
| 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) = { ... }
getTable()
Required. The name of the table in the database to be read.
string table = 3 [(.google.api.field_behavior) = REQUIRED];
| 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];
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()
Returns
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];
| 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;
| 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;
| Type | Description |
| boolean | Whether the transaction field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public PartitionReadRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PartitionReadRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public PartitionReadRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
