Class ExplainRequest

Request for Explain

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

Inheritance
object
RequestBase<ExplainRequestParameters>
PlainRequestBase<ExplainRequestParameters>
ExplainRequest
ExplainRequest<TDocument>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ExplainRequest : PlainRequestBase<ExplainRequestParameters>, IExplainRequest, IRequest<ExplainRequestParameters>, IRequest

Constructors

| Edit this page View Source

ExplainRequest()

Used for serialization purposes, making sure we have a parameterless constructor

Declaration
protected ExplainRequest()
| Edit this page View Source

ExplainRequest(IndexName, Id)

/{index}/_explain/{id}

Declaration
public ExplainRequest(IndexName index, Id id)
Parameters
Type Name Description
IndexName index

this parameter is required
Id id

this parameter is required

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

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

Query

Declaration
public QueryContainer Query { get; set; }
Property Value
Type Description
QueryContainer
| 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

A document is routed to a particular shard in an index using the following formula

shard_num = hash(_routing) % num_primary_shards

OpenSearch will use the document id if not provided.

For requests that are constructed from/for a document OpenSearch.Client will automatically infer the routing key if that document has a JoinField or a routing mapping on for its type exists on ConnectionSettings

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

Self

Declaration
protected IExplainRequest Self { get; }
Property Value
Type Description
IExplainRequest
| Edit this page View Source

SourceEnabled

Whether the _source should be included in the response.

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 Fields SourceExcludes { get; set; }
Property Value
Type Description
Fields
| Edit this page View Source

SourceIncludes

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

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

StoredFields

Declaration
public Fields StoredFields { get; set; }
Property Value
Type Description
Fields

Implements

Extension Methods