com.couchbase.client.java.kv

Class SamplingScan

java.lang.Object

com.couchbase.client.java.kv.ScanType

com.couchbase.client.java.kv.SamplingScan

@Stability.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SamplingScan.Built

Method Summary

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

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

build

@Stability.Internal
public SamplingScan.Built build()

Specified by:

build in class ScanType

toString

public String toString()

Overrides:

toString in class Object