public static final class ReadRequest.Builder extends GeneratedMessageV3.Builder<ReadRequest.Builder> implements ReadRequestOrBuilderThe request for Read and StreamingRead.
Protobuf type google.spanner.v1.ReadRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ReadRequest.BuilderImplements
ReadRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllColumns(Iterable<String> values)
public ReadRequest.Builder addAllColumns(Iterable<String> values)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 |
values |
Iterable<String>The columns to add. |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
addColumns(String value)
public ReadRequest.Builder addColumns(String value)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 |
value |
StringThe columns to add. |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
addColumnsBytes(ByteString value)
public ReadRequest.Builder addColumnsBytes(ByteString value)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 |
value |
ByteStringThe bytes of the columns to add. |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ReadRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
build()
public ReadRequest build()| Returns | |
|---|---|
| Type | Description |
ReadRequest |
|
buildPartial()
public ReadRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ReadRequest |
|
clear()
public ReadRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
clearColumns()
public ReadRequest.Builder clearColumns()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 |
ReadRequest.Builder |
This builder for chaining. |
clearDataBoostEnabled()
public ReadRequest.Builder clearDataBoostEnabled() 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 |
ReadRequest.Builder |
This builder for chaining. |
clearDirectedReadOptions()
public ReadRequest.Builder clearDirectedReadOptions()Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 14;
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ReadRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
clearIndex()
public ReadRequest.Builder clearIndex()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 |
ReadRequest.Builder |
This builder for chaining. |
clearKeySet()
public ReadRequest.Builder clearKeySet() 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 |
ReadRequest.Builder |
|
clearLimit()
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;
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
clearLockHint()
public ReadRequest.Builder clearLockHint()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 |
ReadRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ReadRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
clearOrderBy()
public ReadRequest.Builder clearOrderBy()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 |
ReadRequest.Builder |
This builder for chaining. |
clearPartitionToken()
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;
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
clearRequestOptions()
public ReadRequest.Builder clearRequestOptions()Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
clearResumeToken()
public ReadRequest.Builder clearResumeToken() 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 |
ReadRequest.Builder |
This builder for chaining. |
clearSession()
public ReadRequest.Builder clearSession()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 |
ReadRequest.Builder |
This builder for chaining. |
clearTable()
public ReadRequest.Builder clearTable()Required. The name of the table in the database to be read.
string table = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
clearTransaction()
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;
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
clone()
public ReadRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
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 |
intThe 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 |
intThe 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];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the columns. |
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()| Returns | |
|---|---|
| Type | Description |
ReadRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDirectedReadOptions()
public DirectedReadOptions getDirectedReadOptions()Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 14;
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions |
The directedReadOptions. |
getDirectedReadOptionsBuilder()
public DirectedReadOptions.Builder getDirectedReadOptionsBuilder()Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 14;
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions.Builder |
|
getDirectedReadOptionsOrBuilder()
public DirectedReadOptionsOrBuilder getDirectedReadOptionsOrBuilder()Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 14;
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptionsOrBuilder |
|
getIndex()
public 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 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. |
getKeySetBuilder()
public KeySet.Builder getKeySetBuilder() 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.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
KeySetOrBuilder |
|
getLimit()
public 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. |
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];
| Returns | |
|---|---|
| Type | Description |
ReadRequest.LockHint |
The lockHint. |
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];
| Returns | |
|---|---|
| Type | Description |
ReadRequest.OrderBy |
The orderBy. |
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. |
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;
| Returns | |
|---|---|
| Type | Description |
RequestOptions |
The requestOptions. |
getRequestOptionsBuilder()
public RequestOptions.Builder getRequestOptionsBuilder()Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
| Returns | |
|---|---|
| Type | Description |
RequestOptions.Builder |
|
getRequestOptionsOrBuilder()
public RequestOptionsOrBuilder getRequestOptionsOrBuilder()Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
| Returns | |
|---|---|
| Type | Description |
RequestOptionsOrBuilder |
|
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. |
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()
public 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 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;
| Returns | |
|---|---|
| Type | Description |
TransactionSelector |
The transaction. |
getTransactionBuilder()
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;
| Returns | |
|---|---|
| Type | Description |
TransactionSelector.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
TransactionSelectorOrBuilder |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeDirectedReadOptions(DirectedReadOptions value)
public ReadRequest.Builder mergeDirectedReadOptions(DirectedReadOptions value)Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 14;
| Parameter | |
|---|---|
| Name | Description |
value |
DirectedReadOptions |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ReadRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ReadRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
mergeFrom(ReadRequest other)
public ReadRequest.Builder mergeFrom(ReadRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ReadRequest |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
mergeKeySet(KeySet value)
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 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];
| Parameter | |
|---|---|
| Name | Description |
value |
KeySet |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
mergeRequestOptions(RequestOptions value)
public ReadRequest.Builder mergeRequestOptions(RequestOptions value)Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
RequestOptions |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
mergeTransaction(TransactionSelector value)
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;
| Parameter | |
|---|---|
| Name | Description |
value |
TransactionSelector |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ReadRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
setColumns(int index, String value)
public ReadRequest.Builder setColumns(int index, String value)Required. The columns of table to be returned for each row matching this request.
repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe columns to set. |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
setDataBoostEnabled(boolean value)
public ReadRequest.Builder setDataBoostEnabled(boolean value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe dataBoostEnabled to set. |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
setDirectedReadOptions(DirectedReadOptions value)
public ReadRequest.Builder setDirectedReadOptions(DirectedReadOptions value)Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 14;
| Parameter | |
|---|---|
| Name | Description |
value |
DirectedReadOptions |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
setDirectedReadOptions(DirectedReadOptions.Builder builderForValue)
public ReadRequest.Builder setDirectedReadOptions(DirectedReadOptions.Builder builderForValue)Directed read options for this request.
.google.spanner.v1.DirectedReadOptions directed_read_options = 14;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
DirectedReadOptions.Builder |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ReadRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
setIndex(String value)
public ReadRequest.Builder setIndex(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe index to set. |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
setIndexBytes(ByteString value)
public ReadRequest.Builder setIndexBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for index to set. |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
setKeySet(KeySet value)
public 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 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];
| Parameter | |
|---|---|
| Name | Description |
value |
KeySet |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
setKeySet(KeySet.Builder builderForValue)
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 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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
KeySet.Builder |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
setLimit(long value)
public 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;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe limit to set. |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
setLockHint(ReadRequest.LockHint value)
public ReadRequest.Builder setLockHint(ReadRequest.LockHint value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ReadRequest.LockHintThe lockHint to set. |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
setLockHintValue(int value)
public ReadRequest.Builder setLockHintValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for lockHint to set. |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
setOrderBy(ReadRequest.OrderBy value)
public ReadRequest.Builder setOrderBy(ReadRequest.OrderBy value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ReadRequest.OrderByThe orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
setOrderByValue(int value)
public ReadRequest.Builder setOrderByValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
setPartitionToken(ByteString value)
public ReadRequest.Builder setPartitionToken(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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe partitionToken to set. |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ReadRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
setRequestOptions(RequestOptions value)
public ReadRequest.Builder setRequestOptions(RequestOptions value)Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
RequestOptions |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
setRequestOptions(RequestOptions.Builder builderForValue)
public ReadRequest.Builder setRequestOptions(RequestOptions.Builder builderForValue)Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
RequestOptions.Builder |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
setResumeToken(ByteString value)
public ReadRequest.Builder setResumeToken(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe resumeToken to set. |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
setSession(String value)
public ReadRequest.Builder setSession(String value)Required. The session in which the read should be performed.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe session to set. |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
setSessionBytes(ByteString value)
public ReadRequest.Builder setSessionBytes(ByteString value)Required. The session in which the read should be performed.
string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for session to set. |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
setTable(String value)
public ReadRequest.Builder setTable(String value)Required. The name of the table in the database to be read.
string table = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe table to set. |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
setTableBytes(ByteString value)
public ReadRequest.Builder setTableBytes(ByteString value)Required. The name of the table in the database to be read.
string table = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for table to set. |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
This builder for chaining. |
setTransaction(TransactionSelector value)
public 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;
| Parameter | |
|---|---|
| Name | Description |
value |
TransactionSelector |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
setTransaction(TransactionSelector.Builder builderForValue)
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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
TransactionSelector.Builder |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ReadRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ReadRequest.Builder |
|