@Generated(value="software.amazon.awssdk:codegen") public final class DocumentSuggesterOptions extends Object implements ToCopyableBuilder<DocumentSuggesterOptions.Builder,DocumentSuggesterOptions>
Options for a search suggester.
Modifier and Type | Class and Description |
---|---|
static interface |
DocumentSuggesterOptions.Builder |
Modifier and Type | Method and Description |
---|---|
static DocumentSuggesterOptions.Builder |
builder() |
boolean |
equals(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() |
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String sourceField()
The name of the index field you want to use for suggestions.
public 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()
.
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.SuggesterFuzzyMatching
public 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()
.
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.SuggesterFuzzyMatching
public 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.
_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.public DocumentSuggesterOptions.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DocumentSuggesterOptions.Builder,DocumentSuggesterOptions>
public static DocumentSuggesterOptions.Builder builder()
public static Class<? extends DocumentSuggesterOptions.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.