Class SearchRequestParameters

Request options for Search

<p>https://docs.opensearch.org/latest/search-plugins/async/index/#rest-api</p>
Inheritance
object
RequestParameters<SearchRequestParameters>
SearchRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.AsynchronousSearchApi
Assembly: OpenSearch.Net.dll
Syntax
public class SearchRequestParameters : RequestParameters<SearchRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

DefaultHttpMethod

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

Index

The name of the index to be searched. Can be an individual name, a comma-separated list of indexes, or a wildcard expression of index names.

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

KeepAlive

The amount of time that the result is saved in the cluster. For example, 2d means that the results are stored in the cluster for 48 hours. The saved search results are deleted after this period or if the search is canceled. Note that this includes the query execution time. If the query exceeds this amount of time, the process cancels this query automatically.

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

KeepOnCompletion

Whether to save the results in the cluster after the search is complete. You can examine the stored results at a later time.

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

OperationName

The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

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

SupportsBody

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

WaitForCompletionTimeout

The amount of time to wait for the results. You can poll the remaining results based on an ID. The maximum value is 300 seconds. Default is 1s.

Declaration
public string WaitForCompletionTimeout { get; set; }
Property Value
Type Description
string

Implements

Extension Methods