com.google.cloud.spring.data.spanner.core

Class SpannerReadOptions

java.lang.Object

com.google.cloud.spring.data.spanner.core.AbstractSpannerRequestOptions<Options.ReadOption>

com.google.cloud.spring.data.spanner.core.SpannerReadOptions

All Implemented Interfaces:

Serializable

public class SpannerReadOptions
extends AbstractSpannerRequestOptions<Options.ReadOption>

Encapsulates Cloud Spanner read options.

Since:

1.1

Author:

Chengyuan Zhao, Mike Eltsufin

See Also:

Serialized Form

Field Summary

Fields inherited from class com.google.cloud.spring.data.spanner.core.AbstractSpannerRequestOptions

requestOptions, requestOptionType

Constructor Summary

Constructors

Constructor and Description
SpannerReadOptions() Constructor to create an instance.

Method Summary

Modifier and Type	Method and Description
SpannerReadOptions	addReadOption(Options.ReadOption readOption)
String	getIndex()
SpannerReadOptions	setAllowPartialRead(boolean allowPartialRead)
SpannerReadOptions	setIncludeProperties(Set<String> includeProperties)
SpannerReadOptions	setIndex(String index)
SpannerReadOptions	setTimestamp(com.google.cloud.Timestamp timestamp)
SpannerReadOptions	setTimestampBound(TimestampBound timestampBound) Set if this query should be executed with bounded staleness.
SpannerQueryOptions	toQueryOptions() In many cases a SpannerReadOptions class instance could be compatible with SpannerQueryOptions.

Methods inherited from class com.google.cloud.spring.data.spanner.core.AbstractSpannerRequestOptions

getIncludeProperties, getOptions, getTimestamp, getTimestampBound, isAllowPartialRead

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpannerReadOptions

public SpannerReadOptions()

Constructor to create an instance. Use the extension-style add/set functions to add options and settings.

Method Detail

addReadOption

public SpannerReadOptions addReadOption(Options.ReadOption readOption)

getIndex

public String getIndex()

setIndex

public SpannerReadOptions setIndex(String index)

setIncludeProperties

public SpannerReadOptions setIncludeProperties(Set<String> includeProperties)

Overrides:

setIncludeProperties in class AbstractSpannerRequestOptions<Options.ReadOption>

setTimestampBound

public SpannerReadOptions setTimestampBound(TimestampBound timestampBound)

Description copied from class: AbstractSpannerRequestOptions

Set if this query should be executed with bounded staleness.

Overrides:

setTimestampBound in class AbstractSpannerRequestOptions<Options.ReadOption>

Parameters:

timestampBound - the timestamp bound. Can be exact or bounded staleness.

Returns:

this options object.

setTimestamp

public SpannerReadOptions setTimestamp(com.google.cloud.Timestamp timestamp)

Overrides:

setTimestamp in class AbstractSpannerRequestOptions<Options.ReadOption>

setAllowPartialRead

public SpannerReadOptions setAllowPartialRead(boolean allowPartialRead)

Overrides:

setAllowPartialRead in class AbstractSpannerRequestOptions<Options.ReadOption>

toQueryOptions

public SpannerQueryOptions toQueryOptions()

In many cases a SpannerReadOptions class instance could be compatible with SpannerQueryOptions. The method executes such conversion or throws an exception if it's impossible.

Returns:

query-parameters

Throws:

IllegalArgumentException - when SpannerQueryOptions can't be converted to SpannerQueryOptions.