Class ExplainRequestParameters
Request options for Explain
https://opensearch.org/docs/latest/opensearch/rest-api/explain/
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class ExplainRequestParameters : RequestParameters<ExplainRequestParameters>, IRequestParameters
Properties
| Edit this page View SourceAnalyzeWildcard
Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
Declaration
public bool? AnalyzeWildcard { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Analyzer
The analyzer for the query string query
Declaration
public string Analyzer { get; set; }
Property Value
Type | Description |
---|---|
string |
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 default field for query string query (default: _all)
Declaration
public string Df { get; set; }
Property Value
Type | Description |
---|---|
string |
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? |
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 |
Routing
Specific routing value
Declaration
public string Routing { get; set; }
Property Value
Type | Description |
---|---|
string |
SourceEnabled
True or false to return the _source field or not, or a list of fields to return
Declaration
public bool? SourceEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool? |
SourceExcludes
A list of fields to exclude from the returned _source field
Declaration
public string[] SourceExcludes { get; set; }
Property Value
Type | Description |
---|---|
string[] |
SourceIncludes
A list of fields to extract and return from the _source field
Declaration
public string[] SourceIncludes { get; set; }
Property Value
Type | Description |
---|---|
string[] |
StoredFields
A comma-separated list of stored fields to return in the response
Declaration
public string[] StoredFields { get; set; }
Property Value
Type | Description |
---|---|
string[] |
SupportsBody
Declaration
public override bool SupportsBody { get; }
Property Value
Type | Description |
---|---|
bool |