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

Class PartitionReadRequest

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.PartitionReadRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

The request for PartitionRead

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
PartitionReadRequest()

Method Summary

Modifier and Type	Method and Description
PartitionReadRequest	clone()
List<String>	getColumns() The columns of table to be returned for each row matching this request.
String	getIndex() If non-empty, the name of an index on table.
KeySet	getKeySet() Required.
PartitionOptions	getPartitionOptions() Additional options that affect how many partitions are created.
String	getTable() Required.
TransactionSelector	getTransaction() Read only snapshot transactions are supported, read/write and single use transactions are not.
PartitionReadRequest	set(String fieldName, Object value)
PartitionReadRequest	setColumns(List<String> columns) The columns of table to be returned for each row matching this request.
PartitionReadRequest	setIndex(String index) If non-empty, the name of an index on table.
PartitionReadRequest	setKeySet(KeySet keySet) Required.
PartitionReadRequest	setPartitionOptions(PartitionOptions partitionOptions) Additional options that affect how many partitions are created.
PartitionReadRequest	setTable(String table) Required.
PartitionReadRequest	setTransaction(TransactionSelector transaction) Read only snapshot transactions are supported, read/write and single use transactions are not.

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

PartitionReadRequest

public PartitionReadRequest()

Method Detail

getColumns

public List<String> getColumns()

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

Returns:

value or null for none

setColumns

public PartitionReadRequest setColumns(List<String> columns)

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

Parameters:

columns - columns 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 PartitionReadRequest 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. 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 PartitionReadRequest 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. 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

getPartitionOptions

public PartitionOptions getPartitionOptions()

Additional options that affect how many partitions are created.

Returns:

value or null for none

setPartitionOptions

public PartitionReadRequest setPartitionOptions(PartitionOptions partitionOptions)

Additional options that affect how many partitions are created.

Parameters:

partitionOptions - partitionOptions or 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 PartitionReadRequest 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()

Read only snapshot transactions are supported, read/write and single use transactions are not.

Returns:

value or null for none

setTransaction

public PartitionReadRequest setTransaction(TransactionSelector transaction)

Read only snapshot transactions are supported, read/write and single use transactions are not.

Parameters:

transaction - transaction or null for none

set

public PartitionReadRequest set(String fieldName,
                                Object value)

Overrides:

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

clone

public PartitionReadRequest clone()

Overrides:

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