Class MultiSearchRequestParameters

Request options for MultiSearch

https://opensearch.org/docs/latest/api-reference/multi-search/

Inheritance

object

RequestParameters<MultiSearchRequestParameters>

MultiSearchRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<MultiSearchRequestParameters>.CustomResponseBuilder

RequestParameters<MultiSearchRequestParameters>.QueryString

RequestParameters<MultiSearchRequestParameters>.RequestConfiguration

RequestParameters<MultiSearchRequestParameters>.ContainsQueryString(string)

RequestParameters<MultiSearchRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<MultiSearchRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<MultiSearchRequestParameters>.SetQueryString(string, object)

RequestParameters<MultiSearchRequestParameters>.Q<TOut>(string)

RequestParameters<MultiSearchRequestParameters>.Q(string, object)

RequestParameters<MultiSearchRequestParameters>.SetAcceptHeader(string)

RequestParameters<MultiSearchRequestParameters>.AcceptHeaderFromFormat(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net

Assembly: OpenSearch.Net.dll

Syntax

public class MultiSearchRequestParameters : RequestParameters<MultiSearchRequestParameters>, IRequestParameters

Properties

CcsMinimizeRoundtrips

If true, network round-trips between the coordinating node and remote clusters are minimized for cross-cluster search requests.

Declaration

public bool? CcsMinimizeRoundtrips { get; set; }

Property Value

Type	Description
bool?

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<MultiSearchRequestParameters>.DefaultHttpMethod

MaxConcurrentSearches

Maximum number of concurrent searches the multi search API can execute.

Declaration

public long? MaxConcurrentSearches { get; set; }

Property Value

Type	Description
long?

MaxConcurrentShardRequests

Maximum number of concurrent shard requests that each sub-search request executes per node.

Declaration

public long? MaxConcurrentShardRequests { get; set; }

Property Value

Type	Description
long?

PreFilterShardSize

Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint.

Declaration

public long? PreFilterShardSize { get; set; }

Property Value

Type	Description
long?

SearchType

Indicates whether global term and document frequencies should be used when scoring returned documents.

Declaration

public SearchType? SearchType { get; set; }

Property Value

Type	Description
SearchType?

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<MultiSearchRequestParameters>.SupportsBody

TotalHitsAsInteger

If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object.

Declaration

public bool? TotalHitsAsInteger { get; set; }

Property Value

Type	Description
bool?

TypedKeys

Specifies whether aggregation and suggester names should be prefixed by their respective types in the response.

Declaration

public bool? TypedKeys { get; set; }

Property Value

Type	Description
bool?

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)