Package glide.api.models.commands.scan

Class HScanOptions

java.lang.Object

glide.api.models.commands.scan.BaseScanOptions

glide.api.models.commands.scan.HScanOptions

public class HScanOptions
extends BaseScanOptions

Optional arguments for HashBaseCommands.hscan(String, String, HScanOptions).

See Also:

valkey.io

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HScanOptions.HScanOptionsBuilder<C extends HScanOptions,B extends HScanOptions.HScanOptionsBuilder<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_VALUES_API	Option string to include in the HSCAN command when values are not included.
protected boolean	noValues	When set to true, the command will not include values 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	HScanOptions(HScanOptions.HScanOptionsBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static HScanOptions.HScanOptionsBuilder<?,?>	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 HSCAN commands.

Methods inherited from class java.lang.Object

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

Field Detail

NO_VALUES_API

public static final java.lang.String NO_VALUES_API

Option string to include in the HSCAN command when values are not included.

See Also:

Constant Field Values

noValues

protected boolean noValues

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

Constructor Detail

HScanOptions

protected HScanOptions(HScanOptions.HScanOptionsBuilder<?,?> 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 HSCAN commands.

Overrides:

toGlideStringArgs in class BaseScanOptions

Returns:

a GlideString array that holds the options and their arguments.

builder

public static HScanOptions.HScanOptionsBuilder<?,?> 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