public static final class ReadRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ReadRequest.Builder> implements ReadRequestOrBuilder
The request for [Read][google.spanner.v1.Spanner.Read] and [StreamingRead][google.spanner.v1.Spanner.StreamingRead].Protobuf type
google.spanner.v1.ReadRequest| Modifier and Type | Method and Description |
|---|---|
ReadRequest.Builder |
addAllColumns(Iterable<String> values)
The columns of [table][google.spanner.v1.ReadRequest.table] to be returned
for each row matching this request.
|
ReadRequest.Builder |
addColumns(String value)
The columns of [table][google.spanner.v1.ReadRequest.table] to be returned
for each row matching this request.
|
ReadRequest.Builder |
addColumnsBytes(com.google.protobuf.ByteString value)
The columns of [table][google.spanner.v1.ReadRequest.table] to be returned
for each row matching this request.
|
ReadRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ReadRequest |
build() |
ReadRequest |
buildPartial() |
ReadRequest.Builder |
clear() |
ReadRequest.Builder |
clearColumns()
The columns of [table][google.spanner.v1.ReadRequest.table] to be returned
for each row matching this request.
|
ReadRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
ReadRequest.Builder |
clearIndex()
If non-empty, the name of an index on
[table][google.spanner.v1.ReadRequest.table].
|
ReadRequest.Builder |
clearKeySet()
Required.
|
ReadRequest.Builder |
clearLimit()
If greater than zero, only the first `limit` rows are yielded.
|
ReadRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
ReadRequest.Builder |
clearPartitionToken()
If present, results will be restricted to the specified partition
previously created using PartitionRead().
|
ReadRequest.Builder |
clearResumeToken()
If this request is resuming a previously interrupted read,
`resume_token` should be copied from the last
[PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the
interruption.
|
ReadRequest.Builder |
clearSession()
Required.
|
ReadRequest.Builder |
clearTable()
Required.
|
ReadRequest.Builder |
clearTransaction()
The transaction to use.
|
ReadRequest.Builder |
clone() |
String |
getColumns(int index)
The columns of [table][google.spanner.v1.ReadRequest.table] to be returned
for each row matching this request.
|
com.google.protobuf.ByteString |
getColumnsBytes(int index)
The columns of [table][google.spanner.v1.ReadRequest.table] to be returned
for each row matching this request.
|
int |
getColumnsCount()
The columns of [table][google.spanner.v1.ReadRequest.table] to be returned
for each row matching this request.
|
com.google.protobuf.ProtocolStringList |
getColumnsList()
The columns of [table][google.spanner.v1.ReadRequest.table] to be returned
for each row matching this request.
|
ReadRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getIndex()
If non-empty, the name of an index on
[table][google.spanner.v1.ReadRequest.table].
|
com.google.protobuf.ByteString |
getIndexBytes()
If non-empty, the name of an index on
[table][google.spanner.v1.ReadRequest.table].
|
KeySet |
getKeySet()
Required.
|
KeySet.Builder |
getKeySetBuilder()
Required.
|
KeySetOrBuilder |
getKeySetOrBuilder()
Required.
|
long |
getLimit()
If greater than zero, only the first `limit` rows are yielded.
|
com.google.protobuf.ByteString |
getPartitionToken()
If present, results will be restricted to the specified partition
previously created using PartitionRead().
|
com.google.protobuf.ByteString |
getResumeToken()
If this request is resuming a previously interrupted read,
`resume_token` should be copied from the last
[PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the
interruption.
|
String |
getSession()
Required.
|
com.google.protobuf.ByteString |
getSessionBytes()
Required.
|
String |
getTable()
Required.
|
com.google.protobuf.ByteString |
getTableBytes()
Required.
|
TransactionSelector |
getTransaction()
The transaction to use.
|
TransactionSelector.Builder |
getTransactionBuilder()
The transaction to use.
|
TransactionSelectorOrBuilder |
getTransactionOrBuilder()
The transaction to use.
|
boolean |
hasKeySet()
Required.
|
boolean |
hasTransaction()
The transaction to use.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
ReadRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ReadRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
ReadRequest.Builder |
mergeFrom(ReadRequest other) |
ReadRequest.Builder |
mergeKeySet(KeySet value)
Required.
|
ReadRequest.Builder |
mergeTransaction(TransactionSelector value)
The transaction to use.
|
ReadRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
ReadRequest.Builder |
setColumns(int index,
String value)
The columns of [table][google.spanner.v1.ReadRequest.table] to be returned
for each row matching this request.
|
ReadRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ReadRequest.Builder |
setIndex(String value)
If non-empty, the name of an index on
[table][google.spanner.v1.ReadRequest.table].
|
ReadRequest.Builder |
setIndexBytes(com.google.protobuf.ByteString value)
If non-empty, the name of an index on
[table][google.spanner.v1.ReadRequest.table].
|
ReadRequest.Builder |
setKeySet(KeySet.Builder builderForValue)
Required.
|
ReadRequest.Builder |
setKeySet(KeySet value)
Required.
|
ReadRequest.Builder |
setLimit(long value)
If greater than zero, only the first `limit` rows are yielded.
|
ReadRequest.Builder |
setPartitionToken(com.google.protobuf.ByteString value)
If present, results will be restricted to the specified partition
previously created using PartitionRead().
|
ReadRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
ReadRequest.Builder |
setResumeToken(com.google.protobuf.ByteString value)
If this request is resuming a previously interrupted read,
`resume_token` should be copied from the last
[PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the
interruption.
|
ReadRequest.Builder |
setSession(String value)
Required.
|
ReadRequest.Builder |
setSessionBytes(com.google.protobuf.ByteString value)
Required.
|
ReadRequest.Builder |
setTable(String value)
Required.
|
ReadRequest.Builder |
setTableBytes(com.google.protobuf.ByteString value)
Required.
|
ReadRequest.Builder |
setTransaction(TransactionSelector.Builder builderForValue)
The transaction to use.
|
ReadRequest.Builder |
setTransaction(TransactionSelector value)
The transaction to use.
|
ReadRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRequest.Builder>public ReadRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRequest.Builder>public ReadRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic ReadRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic ReadRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic ReadRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRequest.Builder>public ReadRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRequest.Builder>public ReadRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRequest.Builder>public ReadRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRequest.Builder>public ReadRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRequest.Builder>public ReadRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRequest.Builder>public ReadRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReadRequest.Builder>public ReadRequest.Builder mergeFrom(ReadRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRequest.Builder>public ReadRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReadRequest.Builder>IOExceptionpublic String getSession()
Required. The session in which the read should be performed.
string session = 1;getSession in interface ReadRequestOrBuilderpublic com.google.protobuf.ByteString getSessionBytes()
Required. The session in which the read should be performed.
string session = 1;getSessionBytes in interface ReadRequestOrBuilderpublic ReadRequest.Builder setSession(String value)
Required. The session in which the read should be performed.
string session = 1;public ReadRequest.Builder clearSession()
Required. The session in which the read should be performed.
string session = 1;public ReadRequest.Builder setSessionBytes(com.google.protobuf.ByteString value)
Required. The session in which the read should be performed.
string session = 1;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;hasTransaction in interface ReadRequestOrBuilderpublic 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;getTransaction in interface ReadRequestOrBuilderpublic ReadRequest.Builder setTransaction(TransactionSelector value)
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;public ReadRequest.Builder setTransaction(TransactionSelector.Builder builderForValue)
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;public ReadRequest.Builder mergeTransaction(TransactionSelector value)
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;public ReadRequest.Builder clearTransaction()
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;public TransactionSelector.Builder getTransactionBuilder()
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;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;getTransactionOrBuilder in interface ReadRequestOrBuilderpublic String getTable()
Required. The name of the table in the database to be read.
string table = 3;getTable in interface ReadRequestOrBuilderpublic com.google.protobuf.ByteString getTableBytes()
Required. The name of the table in the database to be read.
string table = 3;getTableBytes in interface ReadRequestOrBuilderpublic ReadRequest.Builder setTable(String value)
Required. The name of the table in the database to be read.
string table = 3;public ReadRequest.Builder clearTable()
Required. The name of the table in the database to be read.
string table = 3;public ReadRequest.Builder setTableBytes(com.google.protobuf.ByteString value)
Required. The name of the table in the database to be read.
string table = 3;public String getIndex()
If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table]. This index is used instead of the table primary key when interpreting [key_set][google.spanner.v1.ReadRequest.key_set] and sorting result rows. See [key_set][google.spanner.v1.ReadRequest.key_set] for further information.
string index = 4;getIndex in interface ReadRequestOrBuilderpublic com.google.protobuf.ByteString getIndexBytes()
If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table]. This index is used instead of the table primary key when interpreting [key_set][google.spanner.v1.ReadRequest.key_set] and sorting result rows. See [key_set][google.spanner.v1.ReadRequest.key_set] for further information.
string index = 4;getIndexBytes in interface ReadRequestOrBuilderpublic ReadRequest.Builder setIndex(String value)
If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table]. This index is used instead of the table primary key when interpreting [key_set][google.spanner.v1.ReadRequest.key_set] and sorting result rows. See [key_set][google.spanner.v1.ReadRequest.key_set] for further information.
string index = 4;public ReadRequest.Builder clearIndex()
If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table]. This index is used instead of the table primary key when interpreting [key_set][google.spanner.v1.ReadRequest.key_set] and sorting result rows. See [key_set][google.spanner.v1.ReadRequest.key_set] for further information.
string index = 4;public ReadRequest.Builder setIndexBytes(com.google.protobuf.ByteString value)
If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table]. This index is used instead of the table primary key when interpreting [key_set][google.spanner.v1.ReadRequest.key_set] and sorting result rows. See [key_set][google.spanner.v1.ReadRequest.key_set] for further information.
string index = 4;public com.google.protobuf.ProtocolStringList getColumnsList()
The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching this request.
repeated string columns = 5;getColumnsList in interface ReadRequestOrBuilderpublic int getColumnsCount()
The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching this request.
repeated string columns = 5;getColumnsCount in interface ReadRequestOrBuilderpublic String getColumns(int index)
The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching this request.
repeated string columns = 5;getColumns in interface ReadRequestOrBuilderpublic com.google.protobuf.ByteString getColumnsBytes(int index)
The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching this request.
repeated string columns = 5;getColumnsBytes in interface ReadRequestOrBuilderpublic ReadRequest.Builder setColumns(int index, String value)
The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching this request.
repeated string columns = 5;public ReadRequest.Builder addColumns(String value)
The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching this request.
repeated string columns = 5;public ReadRequest.Builder addAllColumns(Iterable<String> values)
The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching this request.
repeated string columns = 5;public ReadRequest.Builder clearColumns()
The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching this request.
repeated string columns = 5;public ReadRequest.Builder addColumnsBytes(com.google.protobuf.ByteString value)
The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching this request.
repeated string columns = 5;public boolean hasKeySet()
Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in [table][google.spanner.v1.ReadRequest.table] to be yielded, unless [index][google.spanner.v1.ReadRequest.index] is present. If [index][google.spanner.v1.ReadRequest.index] is present, then [key_set][google.spanner.v1.ReadRequest.key_set] instead names index keys in [index][google.spanner.v1.ReadRequest.index]. If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is empty, rows are yielded in table primary key order (if [index][google.spanner.v1.ReadRequest.index] is empty) or index key order (if [index][google.spanner.v1.ReadRequest.index] is non-empty). If the [partition_token][google.spanner.v1.ReadRequest.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;hasKeySet in interface ReadRequestOrBuilderpublic KeySet getKeySet()
Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in [table][google.spanner.v1.ReadRequest.table] to be yielded, unless [index][google.spanner.v1.ReadRequest.index] is present. If [index][google.spanner.v1.ReadRequest.index] is present, then [key_set][google.spanner.v1.ReadRequest.key_set] instead names index keys in [index][google.spanner.v1.ReadRequest.index]. If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is empty, rows are yielded in table primary key order (if [index][google.spanner.v1.ReadRequest.index] is empty) or index key order (if [index][google.spanner.v1.ReadRequest.index] is non-empty). If the [partition_token][google.spanner.v1.ReadRequest.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;getKeySet in interface ReadRequestOrBuilderpublic ReadRequest.Builder setKeySet(KeySet value)
Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in [table][google.spanner.v1.ReadRequest.table] to be yielded, unless [index][google.spanner.v1.ReadRequest.index] is present. If [index][google.spanner.v1.ReadRequest.index] is present, then [key_set][google.spanner.v1.ReadRequest.key_set] instead names index keys in [index][google.spanner.v1.ReadRequest.index]. If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is empty, rows are yielded in table primary key order (if [index][google.spanner.v1.ReadRequest.index] is empty) or index key order (if [index][google.spanner.v1.ReadRequest.index] is non-empty). If the [partition_token][google.spanner.v1.ReadRequest.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;public ReadRequest.Builder setKeySet(KeySet.Builder builderForValue)
Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in [table][google.spanner.v1.ReadRequest.table] to be yielded, unless [index][google.spanner.v1.ReadRequest.index] is present. If [index][google.spanner.v1.ReadRequest.index] is present, then [key_set][google.spanner.v1.ReadRequest.key_set] instead names index keys in [index][google.spanner.v1.ReadRequest.index]. If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is empty, rows are yielded in table primary key order (if [index][google.spanner.v1.ReadRequest.index] is empty) or index key order (if [index][google.spanner.v1.ReadRequest.index] is non-empty). If the [partition_token][google.spanner.v1.ReadRequest.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;public ReadRequest.Builder mergeKeySet(KeySet value)
Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in [table][google.spanner.v1.ReadRequest.table] to be yielded, unless [index][google.spanner.v1.ReadRequest.index] is present. If [index][google.spanner.v1.ReadRequest.index] is present, then [key_set][google.spanner.v1.ReadRequest.key_set] instead names index keys in [index][google.spanner.v1.ReadRequest.index]. If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is empty, rows are yielded in table primary key order (if [index][google.spanner.v1.ReadRequest.index] is empty) or index key order (if [index][google.spanner.v1.ReadRequest.index] is non-empty). If the [partition_token][google.spanner.v1.ReadRequest.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;public ReadRequest.Builder clearKeySet()
Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in [table][google.spanner.v1.ReadRequest.table] to be yielded, unless [index][google.spanner.v1.ReadRequest.index] is present. If [index][google.spanner.v1.ReadRequest.index] is present, then [key_set][google.spanner.v1.ReadRequest.key_set] instead names index keys in [index][google.spanner.v1.ReadRequest.index]. If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is empty, rows are yielded in table primary key order (if [index][google.spanner.v1.ReadRequest.index] is empty) or index key order (if [index][google.spanner.v1.ReadRequest.index] is non-empty). If the [partition_token][google.spanner.v1.ReadRequest.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;public KeySet.Builder getKeySetBuilder()
Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in [table][google.spanner.v1.ReadRequest.table] to be yielded, unless [index][google.spanner.v1.ReadRequest.index] is present. If [index][google.spanner.v1.ReadRequest.index] is present, then [key_set][google.spanner.v1.ReadRequest.key_set] instead names index keys in [index][google.spanner.v1.ReadRequest.index]. If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is empty, rows are yielded in table primary key order (if [index][google.spanner.v1.ReadRequest.index] is empty) or index key order (if [index][google.spanner.v1.ReadRequest.index] is non-empty). If the [partition_token][google.spanner.v1.ReadRequest.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;public KeySetOrBuilder getKeySetOrBuilder()
Required. `key_set` identifies the rows to be yielded. `key_set` names the primary keys of the rows in [table][google.spanner.v1.ReadRequest.table] to be yielded, unless [index][google.spanner.v1.ReadRequest.index] is present. If [index][google.spanner.v1.ReadRequest.index] is present, then [key_set][google.spanner.v1.ReadRequest.key_set] instead names index keys in [index][google.spanner.v1.ReadRequest.index]. If the [partition_token][google.spanner.v1.ReadRequest.partition_token] field is empty, rows are yielded in table primary key order (if [index][google.spanner.v1.ReadRequest.index] is empty) or index key order (if [index][google.spanner.v1.ReadRequest.index] is non-empty). If the [partition_token][google.spanner.v1.ReadRequest.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;getKeySetOrBuilder in interface ReadRequestOrBuilderpublic 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;getLimit in interface ReadRequestOrBuilderpublic ReadRequest.Builder setLimit(long value)
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;public ReadRequest.Builder clearLimit()
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;public com.google.protobuf.ByteString getResumeToken()
If this request is resuming a previously interrupted read, `resume_token` should be copied from the last [PartialResultSet][google.spanner.v1.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;getResumeToken in interface ReadRequestOrBuilderpublic ReadRequest.Builder setResumeToken(com.google.protobuf.ByteString value)
If this request is resuming a previously interrupted read, `resume_token` should be copied from the last [PartialResultSet][google.spanner.v1.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;public ReadRequest.Builder clearResumeToken()
If this request is resuming a previously interrupted read, `resume_token` should be copied from the last [PartialResultSet][google.spanner.v1.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;public com.google.protobuf.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;getPartitionToken in interface ReadRequestOrBuilderpublic ReadRequest.Builder setPartitionToken(com.google.protobuf.ByteString value)
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;public ReadRequest.Builder clearPartitionToken()
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;public final ReadRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRequest.Builder>public final ReadRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ReadRequest.Builder>Copyright © 2019 Google LLC. All rights reserved.