Class MultiSearchTemplateRequestParameters

Request options for MultiSearchTemplate

<p>https://docs.opensearch.org/latest/search-plugins/search-template/</p>
Inheritance
object
RequestParameters<MultiSearchTemplateRequestParameters>
MultiSearchTemplateRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class MultiSearchTemplateRequestParameters : RequestParameters<MultiSearchTemplateRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

CcsMinimizeRoundtrips

If true, network round-trips are minimized for cross-cluster search requests.

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

DefaultHttpMethod

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

MaxConcurrentSearches

Maximum number of concurrent searches the API can run.

Declaration
public int? MaxConcurrentSearches { get; set; }
Property Value
Type Description
int?
| 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

SearchType

The type of the search operation. Available options: query_then_fetch, dfs_query_then_fetch.

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

SupportsBody

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

TotalHitsAsInteger

If true, the response returns hits.total as an integer. If false, it returns hits.total as an object.

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

TypedKeys

If true, the response prefixes aggregation and suggester names with their respective types.

Declaration
public bool? TypedKeys { get; set; }
Property Value
Type Description
bool?

Implements

Extension Methods