public interface ReadRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getColumns(int index)
public abstract String getColumns(int index)
Required. The columns of table to be returned for each row matching this request.
repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];
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)
Required. The columns of table to be returned for each row matching this request.
repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];
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()
Required. The columns of table to be returned for each row matching this request.
repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
int | The count of columns. |
getColumnsList()
public abstract List<String> getColumnsList()
Required. The columns of table to be returned for each row matching this request.
repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
List<String> | A list containing the columns. |
getDataBoostEnabled()
public abstract boolean getDataBoostEnabled()
If this is for a partitioned read and this field is set to true
, the
request is executed with Spanner Data Boost independent compute resources.
If the field is set to true
but the request does not set
partition_token
, the API returns an INVALID_ARGUMENT
error.
bool data_boost_enabled = 15;
Returns | |
---|---|
Type | Description |
boolean | The dataBoostEnabled. |
getDirectedReadOptions()
public abstract DirectedReadOptions getDirectedReadOptions()
Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 14;
Returns | |
---|---|
Type | Description |
DirectedReadOptions | The directedReadOptions. |
getDirectedReadOptionsOrBuilder()
public abstract DirectedReadOptionsOrBuilder getDirectedReadOptionsOrBuilder()
Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 14;
Returns | |
---|---|
Type | Description |
DirectedReadOptionsOrBuilder |
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.
If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field is not empty, rows will be yielded in an unspecified order.
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.
If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field is not empty, rows will be yielded in an unspecified order.
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 |
getLimit()
public abstract long getLimit()
If greater than zero, only the first limit
rows are yielded. If limit
is zero, the default is no limit. A limit cannot be specified if
partition_token
is set.
int64 limit = 8;
Returns | |
---|---|
Type | Description |
long | The limit. |
getPartitionToken()
public abstract ByteString getPartitionToken()
If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token.
bytes partition_token = 10;
Returns | |
---|---|
Type | Description |
ByteString | The partitionToken. |
getRequestOptions()
public abstract RequestOptions getRequestOptions()
Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
Returns | |
---|---|
Type | Description |
RequestOptions | The requestOptions. |
getRequestOptionsOrBuilder()
public abstract RequestOptionsOrBuilder getRequestOptionsOrBuilder()
Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
Returns | |
---|---|
Type | Description |
RequestOptionsOrBuilder |
getResumeToken()
public abstract ByteString getResumeToken()
If this request is resuming a previously interrupted read,
resume_token
should be copied from the last
PartialResultSet yielded before the
interruption. Doing this enables the new read to resume where the last read
left off. The rest of the request parameters must exactly match the request
that yielded this token.
bytes resume_token = 9;
Returns | |
---|---|
Type | Description |
ByteString | The resumeToken. |
getSession()
public abstract String getSession()
Required. The session in which the read should be performed.
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 in which the read should be performed.
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()
The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
.google.spanner.v1.TransactionSelector transaction = 2;
Returns | |
---|---|
Type | Description |
TransactionSelector | The transaction. |
getTransactionOrBuilder()
public abstract TransactionSelectorOrBuilder getTransactionOrBuilder()
The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
.google.spanner.v1.TransactionSelector transaction = 2;
Returns | |
---|---|
Type | Description |
TransactionSelectorOrBuilder |
hasDirectedReadOptions()
public abstract boolean hasDirectedReadOptions()
Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 14;
Returns | |
---|---|
Type | Description |
boolean | Whether the directedReadOptions field is set. |
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.
If the partition_token field is empty, rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty). If the partition_token field is not empty, rows will be yielded in an unspecified order.
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. |
hasRequestOptions()
public abstract boolean hasRequestOptions()
Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
Returns | |
---|---|
Type | Description |
boolean | Whether the requestOptions field is set. |
hasTransaction()
public abstract boolean hasTransaction()
The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
.google.spanner.v1.TransactionSelector transaction = 2;
Returns | |
---|---|
Type | Description |
boolean | Whether the transaction field is set. |