public final class SuggestOptions extends Object
Constructor and Description |
---|
SuggestOptions() |
Modifier and Type | Method and Description |
---|---|
String |
getFilter()
Get the filter property: An OData expression that filters the documents considered for suggestions.
|
String |
getHighlightPostTag()
Get the highlightPostTag property: A string tag that is appended to hit highlights.
|
String |
getHighlightPreTag()
Get the highlightPreTag property: A string tag that is prepended to hit highlights.
|
Double |
getMinimumCoverage()
Get the minimumCoverage property: A number between 0 and 100 indicating the percentage of the index that must be
covered by a suggestions query in order for the query to be reported as a success.
|
List<String> |
getOrderBy()
Get the orderBy property: The list of OData $orderby expressions by which to sort the results.
|
List<String> |
getSearchFields()
Get the searchFields property: The list of field names to search for the specified search text.
|
List<String> |
getSelect()
Get the select property: The list of fields to retrieve.
|
Integer |
getTop()
Get the top property: The number of suggestions to retrieve.
|
SuggestOptions |
setFilter(String filter)
Set the filter property: An OData expression that filters the documents considered for suggestions.
|
SuggestOptions |
setHighlightPostTag(String highlightPostTag)
Set the highlightPostTag property: A string tag that is appended to hit highlights.
|
SuggestOptions |
setHighlightPreTag(String highlightPreTag)
Set the highlightPreTag property: A string tag that is prepended to hit highlights.
|
SuggestOptions |
setMinimumCoverage(Double minimumCoverage)
Set the minimumCoverage property: A number between 0 and 100 indicating the percentage of the index that must be
covered by a suggestions query in order for the query to be reported as a success.
|
SuggestOptions |
setOrderBy(String... orderBy)
Set the orderBy property: The list of OData $orderby expressions by which to sort the results.
|
SuggestOptions |
setSearchFields(String... searchFields)
Set the searchFields property: The list of field names to search for the specified search text.
|
SuggestOptions |
setSelect(String... select)
Set the select property: The list of fields to retrieve.
|
SuggestOptions |
setTop(Integer top)
Set the top property: The number of suggestions to retrieve.
|
SuggestOptions |
setUseFuzzyMatching(Boolean useFuzzyMatching)
Set the useFuzzyMatching property: A value indicating whether to use fuzzy matching for the suggestions query.
|
Boolean |
useFuzzyMatching()
Get the useFuzzyMatching property: A value indicating whether to use fuzzy matching for the suggestions query.
|
public String getFilter()
public SuggestOptions setFilter(String filter)
filter
- the filter value to set.public Boolean useFuzzyMatching()
public SuggestOptions setUseFuzzyMatching(Boolean useFuzzyMatching)
useFuzzyMatching
- the useFuzzyMatching value to set.public String getHighlightPostTag()
public SuggestOptions setHighlightPostTag(String highlightPostTag)
highlightPostTag
- the highlightPostTag value to set.public String getHighlightPreTag()
public SuggestOptions setHighlightPreTag(String highlightPreTag)
highlightPreTag
- the highlightPreTag value to set.public Double getMinimumCoverage()
public SuggestOptions setMinimumCoverage(Double minimumCoverage)
minimumCoverage
- the minimumCoverage value to set.public List<String> getOrderBy()
public SuggestOptions setOrderBy(String... orderBy)
orderBy
- the orderBy value to set.public List<String> getSearchFields()
public SuggestOptions setSearchFields(String... searchFields)
searchFields
- the searchFields value to set.public List<String> getSelect()
public SuggestOptions setSelect(String... select)
select
- the select value to set.public Integer getTop()
public SuggestOptions setTop(Integer top)
top
- the top value to set.Copyright © 2021 Microsoft Corporation. All rights reserved.