Package software.amazon.awssdk.services.cloudsearch.model

Class DocumentSuggesterOptions

java.lang.Object

software.amazon.awssdk.services.cloudsearch.model.DocumentSuggesterOptions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DocumentSuggesterOptions.Builder,DocumentSuggesterOptions>

@Generated("software.amazon.awssdk:codegen")
public final class DocumentSuggesterOptions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DocumentSuggesterOptions.Builder,DocumentSuggesterOptions>

Options for a search suggester.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentSuggesterOptions.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentSuggesterOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
SuggesterFuzzyMatching	fuzzyMatching()	The level of fuzziness allowed when suggesting matches for a string: none, low, or high.
String	fuzzyMatchingAsString()	The level of fuzziness allowed when suggesting matches for a string: none, low, or high.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentSuggesterOptions.Builder>	serializableBuilderClass()
String	sortExpression()	An expression that computes a score for each suggestion to control how they are sorted.
String	sourceField()	The name of the index field you want to use for suggestions.
DocumentSuggesterOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

sourceField

public final String sourceField()

The name of the index field you want to use for suggestions.

Returns:

The name of the index field you want to use for suggestions.

fuzzyMatching

public final SuggesterFuzzyMatching fuzzyMatching()

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

If the service returns an enum value that is not available in the current SDK version, fuzzyMatching will return SuggesterFuzzyMatching.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fuzzyMatchingAsString().

Returns:

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

See Also:

SuggesterFuzzyMatching

fuzzyMatchingAsString

public final String fuzzyMatchingAsString()

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

If the service returns an enum value that is not available in the current SDK version, fuzzyMatching will return SuggesterFuzzyMatching.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fuzzyMatchingAsString().

Returns:

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

See Also:

SuggesterFuzzyMatching

sortExpression

public final String sortExpression()

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

Returns:

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

toBuilder

public DocumentSuggesterOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentSuggesterOptions.Builder,DocumentSuggesterOptions>

builder

public static DocumentSuggesterOptions.Builder builder()

serializableBuilderClass

public static Class<? extends DocumentSuggesterOptions.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo