Class SearchRequestParameters
Request options for Search
https://opensearch.org/docs/latest/opensearch/rest-api/search/
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class SearchRequestParameters : RequestParameters<SearchRequestParameters>, IRequestParameters
Properties
| Edit this page View SourceAllowNoIndices
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all
string or when no indices have
been specified)
Declaration
public bool? AllowNoIndices { get; set; }
Property Value
Type | Description |
---|---|
bool? |
AllowPartialSearchResults
Indicate if an error should be returned if there is a partial search failure or timeout
Declaration
public bool? AllowPartialSearchResults { get; set; }
Property Value
Type | Description |
---|---|
bool? |
AnalyzeWildcard
Specify whether wildcard and prefix queries should be analyzed (default: false)
Declaration
public bool? AnalyzeWildcard { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Analyzer
The analyzer to use for the query string
Declaration
public string Analyzer { get; set; }
Property Value
Type | Description |
---|---|
string |
BatchedReduceSize
The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
Declaration
public long? BatchedReduceSize { get; set; }
Property Value
Type | Description |
---|---|
long? |
CcsMinimizeRoundtrips
Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
Declaration
public bool? CcsMinimizeRoundtrips { get; set; }
Property Value
Type | Description |
---|---|
bool? |
DefaultHttpMethod
Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type | Description |
---|---|
HttpMethod |
Overrides
| Edit this page View SourceDefaultOperator
The default operator for query string query (AND or OR)
Declaration
public DefaultOperator? DefaultOperator { get; set; }
Property Value
Type | Description |
---|---|
DefaultOperator? |
Df
The field to use as default where no field prefix is given in the query string
Declaration
public string Df { get; set; }
Property Value
Type | Description |
---|---|
string |
DocValueFields
A comma-separated list of fields to return as the docvalue representation of a field for each hit
Declaration
public string[] DocValueFields { get; set; }
Property Value
Type | Description |
---|---|
string[] |
ExpandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.
Declaration
public ExpandWildcards? ExpandWildcards { get; set; }
Property Value
Type | Description |
---|---|
ExpandWildcards? |
IgnoreThrottled
Whether specified concrete, expanded or aliased indices should be ignored when throttled
Declaration
public bool? IgnoreThrottled { get; set; }
Property Value
Type | Description |
---|---|
bool? |
IgnoreUnavailable
Whether specified concrete indices should be ignored when unavailable (missing or closed)
Declaration
public bool? IgnoreUnavailable { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Lenient
Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
Declaration
public bool? Lenient { get; set; }
Property Value
Type | Description |
---|---|
bool? |
MaxConcurrentShardRequests
The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
Declaration
public long? MaxConcurrentShardRequests { get; set; }
Property Value
Type | Description |
---|---|
long? |
MinCompatibleShardNode
The minimum compatible version that all shards involved in search should have for this request to be successful
Declaration
public string MinCompatibleShardNode { get; set; }
Property Value
Type | Description |
---|---|
string |
PreFilterShardSize
A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
Declaration
public long? PreFilterShardSize { get; set; }
Property Value
Type | Description |
---|---|
long? |
Preference
Specify the node or shard the operation should be performed on (default: random)
Declaration
public string Preference { get; set; }
Property Value
Type | Description |
---|---|
string |
QueryOnQueryString
Query in the Lucene query string syntax
Declaration
public string QueryOnQueryString { get; set; }
Property Value
Type | Description |
---|---|
string |
RequestCache
Specify if request cache should be used for this request or not, defaults to index level setting
Declaration
public bool? RequestCache { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Routing
A comma-separated list of specific routing values
Declaration
public string[] Routing { get; set; }
Property Value
Type | Description |
---|---|
string[] |
Scroll
Specify how long a consistent view of the index should be maintained for scrolled search
Declaration
public TimeSpan Scroll { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
SearchType
Search operation type
Declaration
public SearchType? SearchType { get; set; }
Property Value
Type | Description |
---|---|
SearchType? |
SequenceNumberPrimaryTerm
Specify whether to return sequence number and primary term of the last modification of each hit
Declaration
public bool? SequenceNumberPrimaryTerm { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Stats
Specific 'tag' of the request for logging and statistical purposes
Declaration
public string[] Stats { get; set; }
Property Value
Type | Description |
---|---|
string[] |
StoredFields
A comma-separated list of stored fields to return as part of a hit
Declaration
public string[] StoredFields { get; set; }
Property Value
Type | Description |
---|---|
string[] |
SuggestField
Specify which field to use for suggestions
Declaration
public string SuggestField { get; set; }
Property Value
Type | Description |
---|---|
string |
SuggestMode
Specify suggest mode
Declaration
public SuggestMode? SuggestMode { get; set; }
Property Value
Type | Description |
---|---|
SuggestMode? |
SuggestSize
How many suggestions to return in response
Declaration
public long? SuggestSize { get; set; }
Property Value
Type | Description |
---|---|
long? |
SuggestText
The source text for which the suggestions should be returned
Declaration
public string SuggestText { get; set; }
Property Value
Type | Description |
---|---|
string |
SupportsBody
Declaration
public override bool SupportsBody { get; }
Property Value
Type | Description |
---|---|
bool |
Overrides
| Edit this page View SourceTotalHitsAsInteger
Indicates whether hits.total should be rendered as an integer or an object in the rest search response
Declaration
public bool? TotalHitsAsInteger { get; set; }
Property Value
Type | Description |
---|---|
bool? |
TrackTotalHits
Indicate if the number of documents that match the query should be tracked
Declaration
public string TrackTotalHits { get; set; }
Property Value
Type | Description |
---|---|
string |
TypedKeys
Specify whether aggregation and suggester names should be prefixed by their respective types in the response
Declaration
public bool? TypedKeys { get; set; }
Property Value
Type | Description |
---|---|
bool? |