Class ReadRequest (6.55.0)

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
TypeDescription
int

DATA_BOOST_ENABLED_FIELD_NUMBER

public static final int DATA_BOOST_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

DIRECTED_READ_OPTIONS_FIELD_NUMBER

public static final int DIRECTED_READ_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER
Field Value
TypeDescription
int

KEY_SET_FIELD_NUMBER

public static final int KEY_SET_FIELD_NUMBER
Field Value
TypeDescription
int

LIMIT_FIELD_NUMBER

public static final int LIMIT_FIELD_NUMBER
Field Value
TypeDescription
int

PARTITION_TOKEN_FIELD_NUMBER

public static final int PARTITION_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_OPTIONS_FIELD_NUMBER

public static final int REQUEST_OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

RESUME_TOKEN_FIELD_NUMBER

public static final int RESUME_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

SESSION_FIELD_NUMBER

public static final int SESSION_FIELD_NUMBER
Field Value
TypeDescription
int

TABLE_FIELD_NUMBER

public static final int TABLE_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ReadRequest getDefaultInstance()
Returns
TypeDescription
ReadRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ReadRequest.Builder newBuilder()
Returns
TypeDescription
ReadRequest.Builder

newBuilder(ReadRequest prototype)

public static ReadRequest.Builder newBuilder(ReadRequest prototype)
Parameter
NameDescription
prototypeReadRequest
Returns
TypeDescription
ReadRequest.Builder

parseDelimitedFrom(InputStream input)

public static ReadRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ReadRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ReadRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ReadRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReadRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReadRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ReadRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReadRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReadRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ReadRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ReadRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ReadRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReadRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ReadRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ReadRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReadRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ReadRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ReadRequest> parser()
Returns
TypeDescription
Parser<ReadRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

The dataBoostEnabled.

getDefaultInstanceForType()

public ReadRequest getDefaultInstanceForType()
Returns
TypeDescription
ReadRequest

getDirectedReadOptions()

public DirectedReadOptions getDirectedReadOptions()

Directed read options for this request.

.google.spanner.v1.DirectedReadOptions directed_read_options = 14;

Returns
TypeDescription
DirectedReadOptions

The directedReadOptions.

getDirectedReadOptionsOrBuilder()

public DirectedReadOptionsOrBuilder getDirectedReadOptionsOrBuilder()

Directed read options for this request.

.google.spanner.v1.DirectedReadOptions directed_read_options = 14;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
long

The limit.

getParserForType()

public Parser<ReadRequest> getParserForType()
Returns
TypeDescription
Parser<ReadRequest>
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
TypeDescription
ByteString

The partitionToken.

getRequestOptions()

public RequestOptions getRequestOptions()

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 11;

Returns
TypeDescription
RequestOptions

The requestOptions.

getRequestOptionsOrBuilder()

public RequestOptionsOrBuilder getRequestOptionsOrBuilder()

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 11;

Returns
TypeDescription
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
TypeDescription
ByteString

The resumeToken.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
TransactionSelector

The transaction.

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
TypeDescription
TransactionSelectorOrBuilder

hasDirectedReadOptions()

public boolean hasDirectedReadOptions()

Directed read options for this request.

.google.spanner.v1.DirectedReadOptions directed_read_options = 14;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the keySet field is set.

hasRequestOptions()

public boolean hasRequestOptions()

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 11;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the transaction field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ReadRequest.Builder newBuilderForType()
Returns
TypeDescription
ReadRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReadRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ReadRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ReadRequest.Builder toBuilder()
Returns
TypeDescription
ReadRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException