Class MultiSearchRequest

Request for MultiSearch

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

Inheritance
object
RequestBase<MultiSearchRequestParameters>
PlainRequestBase<MultiSearchRequestParameters>
MultiSearchRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class MultiSearchRequest : PlainRequestBase<MultiSearchRequestParameters>, IMultiSearchRequest, IRequest<MultiSearchRequestParameters>, IRequest

Constructors

| Edit this page View Source

MultiSearchRequest()

/_msearch

Declaration
public MultiSearchRequest()
| Edit this page View Source

MultiSearchRequest(Indices)

/{index}/_msearch

Declaration
public MultiSearchRequest(Indices index)
Parameters
Type Name Description
Indices index

Optional, accepts null

Properties

| Edit this page View Source

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?
| Edit this page View Source

MaxConcurrentSearches

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

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

MaxConcurrentShardRequests

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

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

Operations

Declaration
public IDictionary<string, ISearchRequest> Operations { get; set; }
Property Value
Type Description
IDictionary<string, ISearchRequest>
| Edit this page View Source

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 int? PreFilterShardSize { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

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?
| Edit this page View Source

Self

Declaration
protected IMultiSearchRequest Self { get; }
Property Value
Type Description
IMultiSearchRequest
| Edit this page View Source

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?
| Edit this page View Source

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?

Methods

| Edit this page View Source

RequestDefaults(MultiSearchRequestParameters)

Allows a request implementation to set certain request parameter defaults, use sparingly!

Declaration
protected override sealed void RequestDefaults(MultiSearchRequestParameters parameters)
Parameters
Type Name Description
MultiSearchRequestParameters parameters
Overrides

Implements

Extension Methods