Package com.couchbase.client.java.kv

Class RangeScan

java.lang.Object

com.couchbase.client.java.kv.ScanType

com.couchbase.client.java.kv.RangeScan

@Volatile
public class RangeScan
extends ScanType

Performs a KV range scan to scan between two ScanTerms.

Use ScanType.rangeScan(ScanTerm, ScanTerm) to construct.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RangeScan.Built

Method Summary

Modifier and Type	Method	Description
RangeScan.Built	build()
Optional<ScanTerm>	from()	Returns the ScanTerm used to start scanning from.
Optional<ScanTerm>	to()	Returns the ScanTerm to scan to.

Methods inherited from class com.couchbase.client.java.kv.ScanType

prefixScan, rangeScan, samplingScan, samplingScan

Methods inherited from class java.lang.Object

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

Method Details

from

public Optional<ScanTerm> from()

Returns the ScanTerm used to start scanning from.

Returns:

the ScanTerm used to start scanning from.

to

public Optional<ScanTerm> to()

Returns the ScanTerm to scan to.

Returns:

the ScanTerm to scan to.

build

@Internal
public RangeScan.Built build()

Specified by:

build in class ScanType