Package glide.api.models.commands.scan

Class ZScanOptions

java.lang.Object

glide.api.models.commands.scan.BaseScanOptions

glide.api.models.commands.scan.ZScanOptions

public class ZScanOptions
extends BaseScanOptions

Optional arguments for SortedSetBaseCommands.zscan(String, String, ZScanOptions).

See Also:

valkey.io

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ZScanOptions.ZScanOptionsBuilder<C extends ZScanOptions,B extends ZScanOptions.ZScanOptionsBuilder<C,B>>

Nested classes/interfaces inherited from class glide.api.models.commands.scan.BaseScanOptions

BaseScanOptions.BaseScanOptionsBuilder<C extends BaseScanOptions,B extends BaseScanOptions.BaseScanOptionsBuilder<C,B>>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NO_SCORES_API	Option string to include in the ZSCAN command when scores are not included.
protected boolean	noScores	When set to true, the command will not include scores in the results.

Fields inherited from class glide.api.models.commands.scan.BaseScanOptions

count, COUNT_OPTION_STRING, MATCH_OPTION_STRING, matchPattern, matchPatternBinary

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ZScanOptions(ZScanOptions.ZScanOptionsBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static ZScanOptions.ZScanOptionsBuilder<?,?>	builder()
protected boolean	canEqual(java.lang.Object other)
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String[]	toArgs()	Creates the arguments to be used in SCAN commands.
GlideString[]	toGlideStringArgs()	Creates the arguments to be used in ZSCAN commands.

Methods inherited from class java.lang.Object

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

Field Detail

NO_SCORES_API

public static final java.lang.String NO_SCORES_API

Option string to include in the ZSCAN command when scores are not included.

See Also:

Constant Field Values

noScores

protected boolean noScores

When set to true, the command will not include scores in the results. This option is available from Valkey version 8.0.0 and above.

Constructor Detail

ZScanOptions

protected ZScanOptions(ZScanOptions.ZScanOptionsBuilder<?,?> b)

Method Detail

toArgs

public java.lang.String[] toArgs()

Description copied from class: BaseScanOptions

Creates the arguments to be used in SCAN commands.

Overrides:

toArgs in class BaseScanOptions

Returns:

a String array that holds the options and their arguments.

toGlideStringArgs

public GlideString[] toGlideStringArgs()

Creates the arguments to be used in ZSCAN commands.

Overrides:

toGlideStringArgs in class BaseScanOptions

Returns:

a GlideString array that holds the options and their arguments.

builder

public static ZScanOptions.ZScanOptionsBuilder<?,?> builder()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class BaseScanOptions

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object