public final class ReadRequest extends GeneratedMessageV3 implements ReadRequestOrBuilder
The request for Read and
StreamingRead.
Protobuf type google.spanner.v1.ReadRequest
Static Fields
COLUMNS_FIELD_NUMBER
public static final int COLUMNS_FIELD_NUMBER
Field Value
INDEX_FIELD_NUMBER
public static final int INDEX_FIELD_NUMBER
Field Value
KEY_SET_FIELD_NUMBER
public static final int KEY_SET_FIELD_NUMBER
Field Value
LIMIT_FIELD_NUMBER
public static final int LIMIT_FIELD_NUMBER
Field Value
PARTITION_TOKEN_FIELD_NUMBER
public static final int PARTITION_TOKEN_FIELD_NUMBER
Field Value
REQUEST_OPTIONS_FIELD_NUMBER
public static final int REQUEST_OPTIONS_FIELD_NUMBER
Field Value
RESUME_TOKEN_FIELD_NUMBER
public static final int RESUME_TOKEN_FIELD_NUMBER
Field Value
SESSION_FIELD_NUMBER
public static final int SESSION_FIELD_NUMBER
Field Value
TABLE_FIELD_NUMBER
public static final int TABLE_FIELD_NUMBER
Field Value
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ReadRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ReadRequest.Builder newBuilder()
Returns
newBuilder(ReadRequest prototype)
public static ReadRequest.Builder newBuilder(ReadRequest prototype)
Parameter
Returns
public static ReadRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ReadRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ReadRequest parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ReadRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ReadRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReadRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ReadRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ReadRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ReadRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ReadRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ReadRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ReadRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ReadRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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];
Returns
getDefaultInstanceForType()
public ReadRequest getDefaultInstanceForType()
Returns
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
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];
Returns
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.
|
getParserForType()
public Parser<ReadRequest> getParserForType()
Returns
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
getRequestOptions()
public RequestOptions getRequestOptions()
Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
Returns
getRequestOptionsOrBuilder()
public RequestOptionsOrBuilder getRequestOptionsOrBuilder()
Common options for this request.
.google.spanner.v1.RequestOptions request_options = 11;
Returns
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
getSerializedSize()
public int getSerializedSize()
Returns
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
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
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
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
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ReadRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ReadRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ReadRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions