public final class SearchRequest extends Object
Constructor and Description |
---|
SearchRequest() |
Modifier and Type | Method and Description |
---|---|
List<String> |
getFacets()
Get the facets property: The list of facet expressions to apply to the
search query.
|
String |
getFilter()
Get the filter property: The OData $filter expression to apply to the
search query.
|
String |
getHighlightFields()
Get the highlightFields property: The comma-separated list of field
names to use for hit highlights.
|
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 search query in
order for the query to be reported as a success.
|
String |
getOrderBy()
Get the orderBy property: The comma-separated list of OData $orderby
expressions by which to sort the results.
|
QueryType |
getQueryType()
Get the queryType property: A value that specifies the syntax of the
search query.
|
List<ScoringParameter> |
getScoringParameters()
Get the scoringParameters property: The list of parameter values to be
used in scoring functions (for example, referencePointParameter) using
the format name-values.
|
String |
getScoringProfile()
Get the scoringProfile property: The name of a scoring profile to
evaluate match scores for matching documents in order to sort the
results.
|
String |
getSearchFields()
Get the searchFields property: The comma-separated list of field names
to which to scope the full-text search.
|
SearchMode |
getSearchMode()
Get the searchMode property: A value that specifies whether any or all
of the search terms must be matched in order to count the document as a
match.
|
String |
getSearchText()
Get the searchText property: A full-text search query expression; Use
"*" or omit this parameter to match all documents.
|
String |
getSelect()
Get the select property: The comma-separated list of fields to retrieve.
|
Integer |
getSkip()
Get the skip property: The number of search results to skip.
|
Integer |
getTop()
Get the top property: The number of search results to retrieve.
|
Boolean |
isIncludeTotalResultCount()
Get the includeTotalResultCount property: A value that specifies whether
to fetch the total count of results.
|
SearchRequest |
setFacets(List<String> facets)
Set the facets property: The list of facet expressions to apply to the
search query.
|
SearchRequest |
setFilter(String filter)
Set the filter property: The OData $filter expression to apply to the
search query.
|
SearchRequest |
setHighlightFields(String highlightFields)
Set the highlightFields property: The comma-separated list of field
names to use for hit highlights.
|
SearchRequest |
setHighlightPostTag(String highlightPostTag)
Set the highlightPostTag property: A string tag that is appended to hit
highlights.
|
SearchRequest |
setHighlightPreTag(String highlightPreTag)
Set the highlightPreTag property: A string tag that is prepended to hit
highlights.
|
SearchRequest |
setIncludeTotalResultCount(Boolean includeTotalResultCount)
Set the includeTotalResultCount property: A value that specifies whether
to fetch the total count of results.
|
SearchRequest |
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 search query in
order for the query to be reported as a success.
|
SearchRequest |
setOrderBy(String orderBy)
Set the orderBy property: The comma-separated list of OData $orderby
expressions by which to sort the results.
|
SearchRequest |
setQueryType(QueryType queryType)
Set the queryType property: A value that specifies the syntax of the
search query.
|
SearchRequest |
setScoringParameters(List<ScoringParameter> scoringParameters)
Set the scoringParameters property: The list of parameter values to be
used in scoring functions (for example, referencePointParameter) using
the format name-values.
|
SearchRequest |
setScoringProfile(String scoringProfile)
Set the scoringProfile property: The name of a scoring profile to
evaluate match scores for matching documents in order to sort the
results.
|
SearchRequest |
setSearchFields(String searchFields)
Set the searchFields property: The comma-separated list of field names
to which to scope the full-text search.
|
SearchRequest |
setSearchMode(SearchMode searchMode)
Set the searchMode property: A value that specifies whether any or all
of the search terms must be matched in order to count the document as a
match.
|
SearchRequest |
setSearchText(String searchText)
Set the searchText property: A full-text search query expression; Use
"*" or omit this parameter to match all documents.
|
SearchRequest |
setSelect(String select)
Set the select property: The comma-separated list of fields to retrieve.
|
SearchRequest |
setSkip(Integer skip)
Set the skip property: The number of search results to skip.
|
SearchRequest |
setTop(Integer top)
Set the top property: The number of search results to retrieve.
|
public Boolean isIncludeTotalResultCount()
public SearchRequest setIncludeTotalResultCount(Boolean includeTotalResultCount)
includeTotalResultCount
- the includeTotalResultCount value to set.public List<String> getFacets()
public SearchRequest setFacets(List<String> facets)
facets
- the facets value to set.public String getFilter()
public SearchRequest setFilter(String filter)
filter
- the filter value to set.public String getHighlightFields()
public SearchRequest setHighlightFields(String highlightFields)
highlightFields
- the highlightFields value to set.public String getHighlightPostTag()
public SearchRequest setHighlightPostTag(String highlightPostTag)
highlightPostTag
- the highlightPostTag value to set.public String getHighlightPreTag()
public SearchRequest setHighlightPreTag(String highlightPreTag)
highlightPreTag
- the highlightPreTag value to set.public Double getMinimumCoverage()
public SearchRequest setMinimumCoverage(Double minimumCoverage)
minimumCoverage
- the minimumCoverage value to set.public String getOrderBy()
public SearchRequest setOrderBy(String orderBy)
orderBy
- the orderBy value to set.public QueryType getQueryType()
public SearchRequest setQueryType(QueryType queryType)
queryType
- the queryType value to set.public List<ScoringParameter> getScoringParameters()
public SearchRequest setScoringParameters(List<ScoringParameter> scoringParameters)
scoringParameters
- the scoringParameters value to set.public String getScoringProfile()
public SearchRequest setScoringProfile(String scoringProfile)
scoringProfile
- the scoringProfile value to set.public String getSearchText()
public SearchRequest setSearchText(String searchText)
searchText
- the searchText value to set.public String getSearchFields()
public SearchRequest setSearchFields(String searchFields)
searchFields
- the searchFields value to set.public SearchMode getSearchMode()
public SearchRequest setSearchMode(SearchMode searchMode)
searchMode
- the searchMode value to set.public String getSelect()
public SearchRequest setSelect(String select)
select
- the select value to set.public Integer getSkip()
public SearchRequest setSkip(Integer skip)
skip
- the skip value to set.public Integer getTop()
public SearchRequest setTop(Integer top)
top
- the top value to set.Copyright © 2020 Microsoft Corporation. All rights reserved.