com.google.spanner.v1

Class ReadRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.spanner.v1.ReadRequest

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, ReadRequestOrBuilder, Serializable

public final class ReadRequest
extends GeneratedMessageV3
implements ReadRequestOrBuilder

 The request for [Read][google.spanner.v1.Spanner.Read] and
 [StreamingRead][google.spanner.v1.Spanner.StreamingRead].
 

Protobuf type google.spanner.v1.ReadRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReadRequest.Builder The request for [Read][google.spanner.v1.Spanner.Read] and [StreamingRead][google.spanner.v1.Spanner.StreamingRead].

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	COLUMNS_FIELD_NUMBER
static int	INDEX_FIELD_NUMBER
static int	KEY_SET_FIELD_NUMBER
static int	LIMIT_FIELD_NUMBER
static int	PARTITION_TOKEN_FIELD_NUMBER
static int	REQUEST_OPTIONS_FIELD_NUMBER
static int	RESUME_TOKEN_FIELD_NUMBER
static int	SESSION_FIELD_NUMBER
static int	TABLE_FIELD_NUMBER
static int	TRANSACTION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getColumns(int index) Required.
ByteString	getColumnsBytes(int index) Required.
int	getColumnsCount() Required.
ProtocolStringList	getColumnsList() Required.
static ReadRequest	getDefaultInstance()
ReadRequest	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
String	getIndex() If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table].
ByteString	getIndexBytes() If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table].
KeySet	getKeySet() Required.
KeySetOrBuilder	getKeySetOrBuilder() Required.
long	getLimit() If greater than zero, only the first `limit` rows are yielded.
Parser<ReadRequest>	getParserForType()
ByteString	getPartitionToken() If present, results will be restricted to the specified partition previously created using PartitionRead().
RequestOptions	getRequestOptions() Common options for this request.
RequestOptionsOrBuilder	getRequestOptionsOrBuilder() Common options for this request.
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.
int	getSerializedSize()
String	getSession() Required.
ByteString	getSessionBytes() Required.
String	getTable() Required.
ByteString	getTableBytes() Required.
TransactionSelector	getTransaction() The transaction to use.
TransactionSelectorOrBuilder	getTransactionOrBuilder() The transaction to use.
UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasKeySet() Required.
boolean	hasRequestOptions() Common options for this request.
boolean	hasTransaction() The transaction to use.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ReadRequest.Builder	newBuilder()
static ReadRequest.Builder	newBuilder(ReadRequest prototype)
ReadRequest.Builder	newBuilderForType()
protected ReadRequest.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static ReadRequest	parseDelimitedFrom(InputStream input)
static ReadRequest	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static ReadRequest	parseFrom(byte[] data)
static ReadRequest	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static ReadRequest	parseFrom(ByteBuffer data)
static ReadRequest	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static ReadRequest	parseFrom(ByteString data)
static ReadRequest	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static ReadRequest	parseFrom(CodedInputStream input)
static ReadRequest	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static ReadRequest	parseFrom(InputStream input)
static ReadRequest	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<ReadRequest>	parser()
ReadRequest.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SESSION_FIELD_NUMBER

public static final int SESSION_FIELD_NUMBER

See Also:

Constant Field Values

TRANSACTION_FIELD_NUMBER

public static final int TRANSACTION_FIELD_NUMBER

See Also:

Constant Field Values

TABLE_FIELD_NUMBER

public static final int TABLE_FIELD_NUMBER

See Also:

Constant Field Values

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER

See Also:

Constant Field Values

COLUMNS_FIELD_NUMBER

public static final int COLUMNS_FIELD_NUMBER

See Also:

Constant Field Values

KEY_SET_FIELD_NUMBER

public static final int KEY_SET_FIELD_NUMBER

See Also:

Constant Field Values

LIMIT_FIELD_NUMBER

public static final int LIMIT_FIELD_NUMBER

See Also:

Constant Field Values

RESUME_TOKEN_FIELD_NUMBER

public static final int RESUME_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

PARTITION_TOKEN_FIELD_NUMBER

public static final int PARTITION_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

REQUEST_OPTIONS_FIELD_NUMBER

public static final int REQUEST_OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

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) = { ... }

Specified by:

getSession in interface ReadRequestOrBuilder

Returns:

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) = { ... }

Specified by:

getSessionBytes in interface ReadRequestOrBuilder

Returns:

The bytes for session.

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;

Specified by:

hasTransaction in interface ReadRequestOrBuilder

Returns:

Whether the transaction field is set.

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;

Specified by:

getTransaction in interface ReadRequestOrBuilder

Returns:

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;

Specified by:

getTransactionOrBuilder in interface ReadRequestOrBuilder

getTable

public String getTable()

 Required. The name of the table in the database to be read.
 

string table = 3 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getTable in interface ReadRequestOrBuilder

Returns:

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];

Specified by:

getTableBytes in interface ReadRequestOrBuilder

Returns:

The bytes for table.

getIndex

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;

Specified by:

getIndex in interface ReadRequestOrBuilder

Returns:

The index.

getIndexBytes

public 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;

Specified by:

getIndexBytes in interface ReadRequestOrBuilder

Returns:

The bytes for index.

getColumnsList

public ProtocolStringList getColumnsList()

 Required. The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching
 this request.
 

repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getColumnsList in interface ReadRequestOrBuilder

Returns:

A list containing the columns.

getColumnsCount

public int getColumnsCount()

 Required. The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching
 this request.
 

repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getColumnsCount in interface ReadRequestOrBuilder

Returns:

The count of columns.

getColumns

public String getColumns(int index)

 Required. The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching
 this request.
 

repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getColumns in interface ReadRequestOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The columns at the given index.

getColumnsBytes

public ByteString getColumnsBytes(int index)

 Required. The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching
 this request.
 

repeated string columns = 5 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getColumnsBytes in interface ReadRequestOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the columns at the given index.

hasKeySet

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 [(.google.api.field_behavior) = REQUIRED];

Specified by:

hasKeySet in interface ReadRequestOrBuilder

Returns:

Whether the keySet field is set.

getKeySet

public 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 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getKeySet in interface ReadRequestOrBuilder

Returns:

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][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 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getKeySetOrBuilder in interface ReadRequestOrBuilder

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;

Specified by:

getLimit in interface ReadRequestOrBuilder

Returns:

The limit.

getResumeToken

public 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;

Specified by:

getResumeToken in interface ReadRequestOrBuilder

Returns:

The resumeToken.

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;

Specified by:

getPartitionToken in interface ReadRequestOrBuilder

Returns:

The partitionToken.

hasRequestOptions

public boolean hasRequestOptions()

 Common options for this request.
 

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

Specified by:

hasRequestOptions in interface ReadRequestOrBuilder

Returns:

Whether the requestOptions field is set.

getRequestOptions

public RequestOptions getRequestOptions()

 Common options for this request.
 

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

Specified by:

getRequestOptions in interface ReadRequestOrBuilder

Returns:

The requestOptions.

getRequestOptionsOrBuilder

public RequestOptionsOrBuilder getRequestOptionsOrBuilder()

 Common options for this request.
 

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

Specified by:

getRequestOptionsOrBuilder in interface ReadRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static ReadRequest parseFrom(ByteBuffer data)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ReadRequest parseFrom(ByteBuffer data,
                                    ExtensionRegistryLite extensionRegistry)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ReadRequest parseFrom(ByteString data)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ReadRequest parseFrom(ByteString data,
                                    ExtensionRegistryLite extensionRegistry)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ReadRequest parseFrom(byte[] data)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ReadRequest parseFrom(byte[] data,
                                    ExtensionRegistryLite extensionRegistry)
                             throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ReadRequest parseFrom(InputStream input)
                             throws IOException

Throws:

IOException

parseFrom

public static ReadRequest parseFrom(InputStream input,
                                    ExtensionRegistryLite extensionRegistry)
                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static ReadRequest parseDelimitedFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static ReadRequest parseDelimitedFrom(InputStream input,
                                             ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

parseFrom

public static ReadRequest parseFrom(CodedInputStream input)
                             throws IOException

Throws:

IOException

parseFrom

public static ReadRequest parseFrom(CodedInputStream input,
                                    ExtensionRegistryLite extensionRegistry)
                             throws IOException

Throws:

IOException

newBuilderForType

public ReadRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static ReadRequest.Builder newBuilder()

newBuilder

public static ReadRequest.Builder newBuilder(ReadRequest prototype)

toBuilder

public ReadRequest.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected ReadRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static ReadRequest getDefaultInstance()

parser

public static Parser<ReadRequest> parser()

getParserForType

public Parser<ReadRequest> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public ReadRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder