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

Class SpannerPageableQueryOptions

java.lang.Object

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

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

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

All Implemented Interfaces:

Serializable

public class SpannerPageableQueryOptions
extends SpannerQueryOptions

Encapsulates Cloud Spanner query options with sort and paging.

Since:

1.1

See Also:

• Serialized Form

Field Summary

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

requestOptions, requestOptionType

Constructor Summary

Constructors

Constructor	Description
SpannerPageableQueryOptions()

Method Summary

Modifier and Type	Method	Description
SpannerPageableQueryOptions	addQueryOption(Options.QueryOption queryOption)
Integer	getLimit()
Long	getOffset()
org.springframework.data.domain.Sort	getSort()
SpannerPageableQueryOptions	setAllowPartialRead(boolean allowPartialRead)
SpannerPageableQueryOptions	setIncludeProperties(Set<String> includeProperties)
SpannerPageableQueryOptions	setLimit(Integer limit)
SpannerPageableQueryOptions	setOffset(Long offset)
SpannerPageableQueryOptions	setSort(org.springframework.data.domain.Sort sort)
SpannerPageableQueryOptions	setTimestamp(com.google.cloud.Timestamp timestamp)
SpannerPageableQueryOptions	setTimestampBound(TimestampBound timestampBound)	Set if this query should be executed with bounded staleness.

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 Details

SpannerPageableQueryOptions

public SpannerPageableQueryOptions()

Method Details

getLimit

public Integer getLimit()

setLimit

public SpannerPageableQueryOptions setLimit(Integer limit)

getOffset

public Long getOffset()

setOffset

public SpannerPageableQueryOptions setOffset(Long offset)

getSort

public org.springframework.data.domain.Sort getSort()

setSort

public SpannerPageableQueryOptions setSort(org.springframework.data.domain.Sort sort)

addQueryOption

public SpannerPageableQueryOptions addQueryOption(Options.QueryOption queryOption)

Overrides:

addQueryOption in class SpannerQueryOptions

setIncludeProperties

public SpannerPageableQueryOptions setIncludeProperties(Set<String> includeProperties)

Overrides:

setIncludeProperties in class SpannerQueryOptions

setTimestampBound

public SpannerPageableQueryOptions setTimestampBound(TimestampBound timestampBound)

Description copied from class: AbstractSpannerRequestOptions

Set if this query should be executed with bounded staleness.

Overrides:

setTimestampBound in class SpannerQueryOptions

Parameters:

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

Returns:

this options object.

setTimestamp

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

Overrides:

setTimestamp in class SpannerQueryOptions

setAllowPartialRead

public SpannerPageableQueryOptions setAllowPartialRead(boolean allowPartialRead)

Overrides:

setAllowPartialRead in class SpannerQueryOptions