Class SearchTemplateRequestParameters
Request options for SearchTemplate
https://opensearch.org/docs/latest/opensearch/search-template/
Inheritance
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class SearchTemplateRequestParameters : RequestParameters<SearchTemplateRequestParameters>, 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? |
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 SourceExpandWildcards
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? |
Explain
Specify whether to return detailed information about score computation as part of a hit
Declaration
public bool? Explain { get; set; }
Property Value
Type | Description |
---|---|
bool? |
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? |
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 |
Profile
Specify whether to profile the query execution
Declaration
public bool? Profile { 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? |
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? |
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? |