public final class ReadRequest
extends com.google.api.client.json.GenericJson
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Spanner API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json
com.google.api.client.util.GenericData.Flags
Constructor and Description |
---|
ReadRequest() |
Modifier and Type | Method and Description |
---|---|
ReadRequest |
clone() |
byte[] |
decodePartitionToken()
If present, results will be restricted to the specified partition previously created using
PartitionRead().
|
byte[] |
decodeResumeToken()
If this request is resuming a previously interrupted read, `resume_token` should be copied from
the last PartialResultSet yielded before the interruption.
|
ReadRequest |
encodePartitionToken(byte[] partitionToken)
If present, results will be restricted to the specified partition previously created using
PartitionRead().
|
ReadRequest |
encodeResumeToken(byte[] resumeToken)
If this request is resuming a previously interrupted read, `resume_token` should be copied from
the last PartialResultSet yielded before the interruption.
|
java.util.List<java.lang.String> |
getColumns()
Required.
|
java.lang.String |
getIndex()
If non-empty, the name of an index on table.
|
KeySet |
getKeySet()
Required.
|
java.lang.Long |
getLimit()
If greater than zero, only the first `limit` rows are yielded.
|
java.lang.String |
getPartitionToken()
If present, results will be restricted to the specified partition previously created using
PartitionRead().
|
java.lang.String |
getResumeToken()
If this request is resuming a previously interrupted read, `resume_token` should be copied from
the last PartialResultSet yielded before the interruption.
|
java.lang.String |
getTable()
Required.
|
TransactionSelector |
getTransaction()
The transaction to use.
|
ReadRequest |
set(java.lang.String fieldName,
java.lang.Object value) |
ReadRequest |
setColumns(java.util.List<java.lang.String> columns)
Required.
|
ReadRequest |
setIndex(java.lang.String index)
If non-empty, the name of an index on table.
|
ReadRequest |
setKeySet(KeySet keySet)
Required.
|
ReadRequest |
setLimit(java.lang.Long limit)
If greater than zero, only the first `limit` rows are yielded.
|
ReadRequest |
setPartitionToken(java.lang.String partitionToken)
If present, results will be restricted to the specified partition previously created using
PartitionRead().
|
ReadRequest |
setResumeToken(java.lang.String resumeToken)
If this request is resuming a previously interrupted read, `resume_token` should be copied from
the last PartialResultSet yielded before the interruption.
|
ReadRequest |
setTable(java.lang.String table)
Required.
|
ReadRequest |
setTransaction(TransactionSelector transaction)
The transaction to use.
|
getFactory, setFactory, toPrettyString, toString
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values
public java.util.List<java.lang.String> getColumns()
null
for nonepublic ReadRequest setColumns(java.util.List<java.lang.String> columns)
columns
- columns or null
for nonepublic java.lang.String getIndex()
null
for nonepublic ReadRequest setIndex(java.lang.String index)
index
- index or null
for nonepublic KeySet getKeySet()
null
for nonepublic ReadRequest setKeySet(KeySet keySet)
keySet
- keySet or null
for nonepublic java.lang.Long getLimit()
null
for nonepublic ReadRequest setLimit(java.lang.Long limit)
limit
- limit or null
for nonepublic java.lang.String getPartitionToken()
null
for nonedecodePartitionToken()
public byte[] decodePartitionToken()
null
for nonegetPartitionToken()
public ReadRequest setPartitionToken(java.lang.String partitionToken)
partitionToken
- partitionToken or null
for none#encodePartitionToken()
public ReadRequest encodePartitionToken(byte[] partitionToken)
The value is encoded Base64 or {@code null} for none.
public java.lang.String getResumeToken()
null
for nonedecodeResumeToken()
public byte[] decodeResumeToken()
null
for nonegetResumeToken()
public ReadRequest setResumeToken(java.lang.String resumeToken)
resumeToken
- resumeToken or null
for none#encodeResumeToken()
public ReadRequest encodeResumeToken(byte[] resumeToken)
The value is encoded Base64 or {@code null} for none.
public java.lang.String getTable()
null
for nonepublic ReadRequest setTable(java.lang.String table)
table
- table or null
for nonepublic TransactionSelector getTransaction()
null
for nonepublic ReadRequest setTransaction(TransactionSelector transaction)
transaction
- transaction or null
for nonepublic ReadRequest set(java.lang.String fieldName, java.lang.Object value)
set
in class com.google.api.client.json.GenericJson
public ReadRequest clone()
clone
in class com.google.api.client.json.GenericJson