Class ExplainRequest
Request for Explain
https://opensearch.org/docs/latest/opensearch/rest-api/explain/
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ExplainRequest : PlainRequestBase<ExplainRequestParameters>, IExplainRequest, IRequest<ExplainRequestParameters>, IRequest
Constructors
| Edit this page View SourceExplainRequest()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected ExplainRequest()
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 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 |
DefaultOperator
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 |
Query
Declaration
public QueryContainer Query { get; set; }
Property Value
Type | Description |
---|---|
QueryContainer |
QueryOnQueryString
Query in the Lucene query string syntax
Declaration
public string QueryOnQueryString { get; set; }
Property Value
Type | Description |
---|---|
string |
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 OSC 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 |
Self
Declaration
protected IExplainRequest Self { get; }
Property Value
Type | Description |
---|---|
IExplainRequest |
SourceEnabled
Whether the _source should be included in the response.
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 Fields SourceExcludes { get; set; }
Property Value
Type | Description |
---|---|
Fields |
SourceIncludes
A list of fields to extract and return from the _source field
Declaration
public Fields SourceIncludes { get; set; }
Property Value
Type | Description |
---|---|
Fields |
StoredFields
Declaration
public Fields StoredFields { get; set; }
Property Value
Type | Description |
---|---|
Fields |