Class ExplainRequestParameters

Request options for Explain

https://opensearch.org/docs/latest/api-reference/explain/

Inheritance
object
RequestParameters<ExplainRequestParameters>
ExplainRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class ExplainRequestParameters : RequestParameters<ExplainRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

AnalyzeWildcard

If true, wildcard and prefix queries are analyzed.

Declaration
public bool? AnalyzeWildcard { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Analyzer

Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified.

Declaration
public string Analyzer { get; set; }
Property Value
Type Description
string
| Edit this page View Source

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| Edit this page View Source

DefaultOperator

The default operator for query string query: AND or OR.

Declaration
public DefaultOperator? DefaultOperator { get; set; }
Property Value
Type Description
DefaultOperator?
| Edit this page View Source

Df

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
| Edit this page View Source

Lenient

If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.

Declaration
public bool? Lenient { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Preference

Specifies the node or shard the operation should be performed on. Random by default.

Declaration
public string Preference { get; set; }
Property Value
Type Description
string
| Edit this page View Source

QueryOnQueryString

Query in the Lucene query string syntax.

Declaration
public string QueryOnQueryString { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Routing

Custom value used to route operations to a specific shard.

Declaration
public string[] Routing { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

SourceEnabled

Set to 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?
| Edit this page View Source

SourceExcludes

A comma-separated list of source fields to exclude from the response.

Declaration
public string[] SourceExcludes { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

SourceIncludes

A comma-separated list of source fields to include in the response.

Declaration
public string[] SourceIncludes { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

StoredFields

A comma-separated list of stored fields to return in the response.

Declaration
public string[] StoredFields { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides

Implements

Extension Methods