Package com.couchbase.client.java.kv

Class SamplingScan

java.lang.Object

com.couchbase.client.java.kv.ScanType

com.couchbase.client.java.kv.SamplingScan

@Volatile
public class SamplingScan
extends ScanType

Performs a KV range scan using random sampling.

Use ScanType.samplingScan(long) and ScanType.samplingScan(long, long) to construct.

Method Summary

Modifier and Type	Method	Description
long	limit()	Returns the limit set for this sampling scan.
Optional<Long>	seed()	Returns the seed set for this sampling scan.

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

prefixScan, rangeScan, rangeScan, samplingScan, samplingScan

Methods inherited from class java.lang.Object

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

Method Detail

limit

public long limit()

Returns the limit set for this sampling scan.

Returns:

the limit set for this sampling scan.

seed

public Optional<Long> seed()

Returns the seed set for this sampling scan.

Returns:

the seed set for this sampling scan.