Class SearchRequestParameters

Request options for Search

https://opensearch.org/docs/latest/search-plugins/async/index/#rest-api

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.

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.

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

KeepOnCompletion

Whether you want to save the results in the cluster after the search is complete.

Declaration
public bool? KeepOnCompletion { get; set; }
Property Value
Type Description
bool?
| 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 that you plan to wait for the results.

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

Implements

Extension Methods