public final class ReadRequest extends GeneratedMessageV3 implements ReadRequestOrBuilder
The request for Read and
StreamingRead.
Protobuf type google.spanner.v1.ReadRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
COLUMNS_FIELD_NUMBER
public static final int COLUMNS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DATA_BOOST_ENABLED_FIELD_NUMBER
public static final int DATA_BOOST_ENABLED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DIRECTED_READ_OPTIONS_FIELD_NUMBER
public static final int DIRECTED_READ_OPTIONS_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 |
|
LIMIT_FIELD_NUMBER
public static final int LIMIT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LOCK_HINT_FIELD_NUMBER
public static final int LOCK_HINT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARTITION_TOKEN_FIELD_NUMBER
public static final int PARTITION_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REQUEST_OPTIONS_FIELD_NUMBER
public static final int REQUEST_OPTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESUME_TOKEN_FIELD_NUMBER
public static final int RESUME_TOKEN_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 ReadRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ReadRequest.Builder newBuilder()
newBuilder(ReadRequest prototype)
public static ReadRequest.Builder newBuilder(ReadRequest prototype)
public static ReadRequest parseDelimitedFrom(InputStream input)
public static ReadRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ReadRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ReadRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ReadRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReadRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReadRequest parseFrom(CodedInputStream input)
public static ReadRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ReadRequest parseFrom(InputStream input)
public static ReadRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ReadRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ReadRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ReadRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getColumns(int index)
public 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 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 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 ProtocolStringList getColumnsList()
Required. The columns of table to be
returned for each row matching this request.
repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];
getDataBoostEnabled()
public 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.
|
getDefaultInstanceForType()
public ReadRequest getDefaultInstanceForType()
getDirectedReadOptions()
public DirectedReadOptions getDirectedReadOptions()
Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 14;
getDirectedReadOptionsOrBuilder()
public DirectedReadOptionsOrBuilder getDirectedReadOptionsOrBuilder()
Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 14;
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.
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 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];
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.
|
getLockHint()
public ReadRequest.LockHint getLockHint()
Optional. Lock Hint for the request, it can only be used with read-write
transactions.
.google.spanner.v1.ReadRequest.LockHint lock_hint = 17 [(.google.api.field_behavior) = OPTIONAL];
getLockHintValue()
public int getLockHintValue()
Optional. Lock Hint for the request, it can only be used with read-write
transactions.
.google.spanner.v1.ReadRequest.LockHint lock_hint = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for lockHint.
|
getOrderBy()
public ReadRequest.OrderBy getOrderBy()
Optional. Order for the returned rows.
By default, Spanner will return result rows in primary key order except for
PartitionRead requests. For applications that do not require rows to be
returned in primary key (ORDER_BY_PRIMARY_KEY) order, setting
ORDER_BY_NO_ORDER option allows Spanner to optimize row retrieval,
resulting in lower latencies in certain cases (e.g. bulk point lookups).
.google.spanner.v1.ReadRequest.OrderBy order_by = 16 [(.google.api.field_behavior) = OPTIONAL];
getOrderByValue()
public int getOrderByValue()
Optional. Order for the returned rows.
By default, Spanner will return result rows in primary key order except for
PartitionRead requests. For applications that do not require rows to be
returned in primary key (ORDER_BY_PRIMARY_KEY) order, setting
ORDER_BY_NO_ORDER option allows Spanner to optimize row retrieval,
resulting in lower latencies in certain cases (e.g. bulk point lookups).
.google.spanner.v1.ReadRequest.OrderBy order_by = 16 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for orderBy.
|
getParserForType()
public Parser<ReadRequest> getParserForType()
Overrides
getPartitionToken()
public 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 RequestOptions getRequestOptions()
Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
getRequestOptionsOrBuilder()
public RequestOptionsOrBuilder getRequestOptionsOrBuilder()
Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
getResumeToken()
public 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSession()
public 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 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()
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()
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;
getTransactionOrBuilder()
public 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;
hasDirectedReadOptions()
public 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 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 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 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ReadRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ReadRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ReadRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
