Interface PartitionReadRequestOrBuilder (6.57.0)

Version 6.57.0

• 6.80.1 (latest)
• 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 interface PartitionReadRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getColumns(int index)

public abstract String getColumns(int index)

The columns of table to be returned for each row matching this request.

repeated string columns = 5;

Parameter
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 abstract ByteString getColumnsBytes(int index)

The columns of table to be returned for each row matching this request.

repeated string columns = 5;

Parameter
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 abstract 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 abstract List<String> getColumnsList()

The columns of table to be returned for each row matching this request.

repeated string columns = 5;

Returns
Type	Description
List<String>	A list containing the columns.

getIndex()

public abstract String 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 abstract 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 abstract 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 abstract 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];

Returns
Type	Description
KeySetOrBuilder

getPartitionOptions()

public abstract PartitionOptions getPartitionOptions()

Additional options that affect how many partitions are created.

.google.spanner.v1.PartitionOptions partition_options = 9;

Returns
Type	Description
PartitionOptions	The partitionOptions.

getPartitionOptionsOrBuilder()

public abstract PartitionOptionsOrBuilder getPartitionOptionsOrBuilder()

Additional options that affect how many partitions are created.

.google.spanner.v1.PartitionOptions partition_options = 9;

Returns
Type	Description
PartitionOptionsOrBuilder

getSession()

public abstract 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 abstract 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()

public abstract String 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 abstract 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 abstract TransactionSelector getTransaction()

Read only snapshot transactions are supported, read/write and single use transactions are not.

.google.spanner.v1.TransactionSelector transaction = 2;

Returns
Type	Description
TransactionSelector	The transaction.

getTransactionOrBuilder()

public abstract TransactionSelectorOrBuilder getTransactionOrBuilder()

Read only snapshot transactions are supported, read/write and single use transactions are not.

.google.spanner.v1.TransactionSelector transaction = 2;

Returns
Type	Description
TransactionSelectorOrBuilder

hasKeySet()

public abstract 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 abstract 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 abstract 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.