Package glide.api.models.commands.scan

Class ScanOptions.ScanOptionsBuilder<C extends ScanOptions,B extends ScanOptions.ScanOptionsBuilder<C,B>>

java.lang.Object

glide.api.models.commands.scan.BaseScanOptions.BaseScanOptionsBuilder<C,B>

glide.api.models.commands.scan.ScanOptions.ScanOptionsBuilder<C,B>

Enclosing class:

ScanOptions

public abstract static class ScanOptions.ScanOptionsBuilder<C extends ScanOptions,B extends ScanOptions.ScanOptionsBuilder<C,B>>
extends BaseScanOptions.BaseScanOptionsBuilder<C,B>

Constructor Summary

Constructors

Constructor	Description
ScanOptionsBuilder()

Method Summary

Modifier and Type	Method	Description
B	allowNonCoveredSlots(java.lang.Boolean allowNonCoveredSlots)	If set to true, the scan will perform even if some slots are not covered by any node.
abstract C	build()
protected abstract B	self()
java.lang.String	toString()
B	type(ScanOptions.ObjectType type)	Use this option to ask SCAN to only return objects that match a given type.

Methods inherited from class glide.api.models.commands.scan.BaseScanOptions.BaseScanOptionsBuilder

count, matchPattern, matchPatternBinary

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanOptionsBuilder

public ScanOptionsBuilder()

Method Detail

type

public B type(ScanOptions.ObjectType type)

Use this option to ask SCAN to only return objects that match a given type.
The filter is applied after elements are retrieved from the database, so the option does not reduce the amount of work the server has to do to complete a full iteration. For rare types you may receive no elements in many iterations.

Returns:

this.

allowNonCoveredSlots

public B allowNonCoveredSlots(java.lang.Boolean allowNonCoveredSlots)

If set to true, the scan will perform even if some slots are not covered by any node. It's important to note that when set to true, the scan has no guarantee to cover all keys in the cluster, and the method loses its way to validate the progress of the scan. Defaults to false.

Returns:

this.

self

protected abstract B self()

Specified by:

self in class BaseScanOptions.BaseScanOptionsBuilder<C extends ScanOptions,B extends ScanOptions.ScanOptionsBuilder<C,B>>

build

public abstract C build()

Specified by:

build in class BaseScanOptions.BaseScanOptionsBuilder<C extends ScanOptions,B extends ScanOptions.ScanOptionsBuilder<C,B>>

toString

public java.lang.String toString()

Overrides:

toString in class BaseScanOptions.BaseScanOptionsBuilder<C extends ScanOptions,B extends ScanOptions.ScanOptionsBuilder<C,B>>