io.lettuce.core.search

Class Suggestion

java.lang.Object

io.lettuce.core.search.Suggestion

public class Suggestion
extends Object

Represents a suggestion returned by the FT.SUGGET command.

A suggestion contains the suggestion string itself, and optionally a score and payload when the FT.SUGGET command is called with WITHSCORES and/or WITHPAYLOADS options.

Since:

6.8

Author:

Tihomir Mateev

Constructor Summary

Constructors

Constructor and Description
Suggestion(String value) Create a new suggestion with only the value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getPayload() Deprecated. since 7.8, there is no replacement. Suggestion payloads (WITHPAYLOADS) are deprecated by Redis since RediSearch 2.0.0.
Double	getScore() Get the suggestion score.
String	getValue() Get the suggestion string.
int	hashCode()
boolean	hasPayload() Deprecated. since 7.8, there is no replacement. Suggestion payloads (WITHPAYLOADS) are deprecated by Redis since RediSearch 2.0.0.
boolean	hasScore() Check if this suggestion has a score.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Suggestion

public Suggestion(String value)

Create a new suggestion with only the value.

Parameters:

value - the suggestion string

Method Detail

getValue

public String getValue()

Get the suggestion string.

Returns:

the suggestion value

getScore

public Double getScore()

Get the suggestion score.

Returns:

the suggestion score, or null if not available

getPayload

@Deprecated
public String getPayload()

Deprecated. since 7.8, there is no replacement. Suggestion payloads (WITHPAYLOADS) are deprecated by Redis since RediSearch 2.0.0.

Get the suggestion payload.

Returns:

the suggestion payload, or null if not available

hasScore

public boolean hasScore()

Check if this suggestion has a score.

Returns:

true if the suggestion has a score

hasPayload

@Deprecated
public boolean hasPayload()

Deprecated. since 7.8, there is no replacement. Suggestion payloads (WITHPAYLOADS) are deprecated by Redis since RediSearch 2.0.0.

Check if this suggestion has a payload.

Returns:

true if the suggestion has a payload

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object