com.google.api.services.spanner.v1.model

Class ReadRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.spanner.v1.model.ReadRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ReadRequest
extends com.google.api.client.json.GenericJson

The request for Read and StreamingRead.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Spanner API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ReadRequest()

Method Summary

Modifier and Type	Method and Description
ReadRequest	clone()
byte[]	decodePartitionToken() If present, results are restricted to the specified partition previously created using `PartitionRead`.
byte[]	decodeResumeToken() If this request is resuming a previously interrupted read, `resume_token` should be copied from the last PartialResultSet yielded before the interruption.
ReadRequest	encodePartitionToken(byte[] partitionToken) If present, results are restricted to the specified partition previously created using `PartitionRead`.
ReadRequest	encodeResumeToken(byte[] resumeToken) If this request is resuming a previously interrupted read, `resume_token` should be copied from the last PartialResultSet yielded before the interruption.
List<String>	getColumns() Required.
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.
DirectedReadOptions	getDirectedReadOptions() Directed read options for this request.
String	getIndex() If non-empty, the name of an index on table.
KeySet	getKeySet() Required.
Long	getLimit() If greater than zero, only the first `limit` rows are yielded.
String	getLockHint() Optional.
String	getOrderBy() Optional.
String	getPartitionToken() If present, results are restricted to the specified partition previously created using `PartitionRead`.
RequestOptions	getRequestOptions() Common options for this request.
String	getResumeToken() If this request is resuming a previously interrupted read, `resume_token` should be copied from the last PartialResultSet yielded before the interruption.
String	getTable() Required.
TransactionSelector	getTransaction() The transaction to use.
ReadRequest	set(String fieldName, Object value)
ReadRequest	setColumns(List<String> columns) Required.
ReadRequest	setDataBoostEnabled(Boolean dataBoostEnabled) 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.
ReadRequest	setDirectedReadOptions(DirectedReadOptions directedReadOptions) Directed read options for this request.
ReadRequest	setIndex(String index) If non-empty, the name of an index on table.
ReadRequest	setKeySet(KeySet keySet) Required.
ReadRequest	setLimit(Long limit) If greater than zero, only the first `limit` rows are yielded.
ReadRequest	setLockHint(String lockHint) Optional.
ReadRequest	setOrderBy(String orderBy) Optional.
ReadRequest	setPartitionToken(String partitionToken) If present, results are restricted to the specified partition previously created using `PartitionRead`.
ReadRequest	setRequestOptions(RequestOptions requestOptions) Common options for this request.
ReadRequest	setResumeToken(String resumeToken) If this request is resuming a previously interrupted read, `resume_token` should be copied from the last PartialResultSet yielded before the interruption.
ReadRequest	setTable(String table) Required.
ReadRequest	setTransaction(TransactionSelector transaction) The transaction to use.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ReadRequest

public ReadRequest()

Method Detail

getColumns

public List<String> getColumns()

Required. The columns of table to be returned for each row matching this request.

Returns:

value or null for none

setColumns

public ReadRequest setColumns(List<String> columns)

Required. The columns of table to be returned for each row matching this request.

Parameters:

columns - columns or null for none

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 doesn't set `partition_token`, the API returns an `INVALID_ARGUMENT` error.

Returns:

value or null for none

setDataBoostEnabled

public ReadRequest setDataBoostEnabled(Boolean dataBoostEnabled)

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 doesn't set `partition_token`, the API returns an `INVALID_ARGUMENT` error.

Parameters:

dataBoostEnabled - dataBoostEnabled or null for none

getDirectedReadOptions

public DirectedReadOptions getDirectedReadOptions()

Directed read options for this request.

Returns:

value or null for none

setDirectedReadOptions

public ReadRequest setDirectedReadOptions(DirectedReadOptions directedReadOptions)

Directed read options for this request.

Parameters:

directedReadOptions - directedReadOptions or null for none

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.

Returns:

value or null for none

setIndex

public ReadRequest setIndex(String index)

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.

Parameters:

index - index or null for none

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 isn't empty, rows are yielded in an unspecified order. It isn't an error for the `key_set` to name rows that don't exist in the database. Read yields nothing for nonexistent rows.

Returns:

value or null for none

setKeySet

public ReadRequest setKeySet(KeySet keySet)

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 isn't empty, rows are yielded in an unspecified order. It isn't an error for the `key_set` to name rows that don't exist in the database. Read yields nothing for nonexistent rows.

Parameters:

keySet - keySet or null for none

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 can't be specified if `partition_token` is set.

Returns:

value or null for none

setLimit

public ReadRequest setLimit(Long limit)

If greater than zero, only the first `limit` rows are yielded. If `limit` is zero, the default is no limit. A limit can't be specified if `partition_token` is set.

Parameters:

limit - limit or null for none

getLockHint

public String getLockHint()

Optional. Lock Hint for the request, it can only be used with read-write transactions.

Returns:

value or null for none

setLockHint

public ReadRequest setLockHint(String lockHint)

Optional. Lock Hint for the request, it can only be used with read-write transactions.

Parameters:

lockHint - lockHint or null for none

getOrderBy

public String getOrderBy()

Optional. Order for the returned rows. By default, Spanner returns result rows in primary key order except for PartitionRead requests. For applications that don't 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 (for example, bulk point lookups).

Returns:

value or null for none

setOrderBy

public ReadRequest setOrderBy(String orderBy)

Optional. Order for the returned rows. By default, Spanner returns result rows in primary key order except for PartitionRead requests. For applications that don't 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 (for example, bulk point lookups).

Parameters:

orderBy - orderBy or null for none

getPartitionToken

public String getPartitionToken()

If present, results are 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.

Returns:

value or null for none

See Also:

decodePartitionToken()

decodePartitionToken

public byte[] decodePartitionToken()

If present, results are 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.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getPartitionToken()

setPartitionToken

public ReadRequest setPartitionToken(String partitionToken)

If present, results are 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.

Parameters:

partitionToken - partitionToken or null for none

See Also:

#encodePartitionToken()

encodePartitionToken

public ReadRequest encodePartitionToken(byte[] partitionToken)

If present, results are 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.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getRequestOptions

public RequestOptions getRequestOptions()

Common options for this request.

Returns:

value or null for none

setRequestOptions

public ReadRequest setRequestOptions(RequestOptions requestOptions)

Common options for this request.

Parameters:

requestOptions - requestOptions or null for none

getResumeToken

public String 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.

Returns:

value or null for none

See Also:

decodeResumeToken()

decodeResumeToken

public byte[] decodeResumeToken()

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.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getResumeToken()

setResumeToken

public ReadRequest setResumeToken(String resumeToken)

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.

Parameters:

resumeToken - resumeToken or null for none

See Also:

#encodeResumeToken()

encodeResumeToken

public ReadRequest encodeResumeToken(byte[] resumeToken)

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.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getTable

public String getTable()

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

Returns:

value or null for none

setTable

public ReadRequest setTable(String table)

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

Parameters:

table - table or null for none

getTransaction

public TransactionSelector getTransaction()

The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.

Returns:

value or null for none

setTransaction

public ReadRequest setTransaction(TransactionSelector transaction)

The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.

Parameters:

transaction - transaction or null for none

set

public ReadRequest set(String fieldName,
                       Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ReadRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson