Class MultiSearchRequest
Request for MultiSearch
https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class MultiSearchRequest : PlainRequestBase<MultiSearchRequestParameters>, IMultiSearchRequest, IRequest<MultiSearchRequestParameters>, IRequest
Constructors
| Edit this page View SourceMultiSearchRequest()
/_msearch
Declaration
public MultiSearchRequest()
MultiSearchRequest(Indices)
/{index}/_msearch
Declaration
public MultiSearchRequest(Indices index)
Parameters
Type | Name | Description |
---|---|---|
Indices | index | Optional, accepts null |
Properties
| Edit this page View SourceCcsMinimizeRoundtrips
Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
Declaration
public bool? CcsMinimizeRoundtrips { get; set; }
Property Value
Type | Description |
---|---|
bool? |
MaxConcurrentSearches
Controls the maximum number of concurrent searches the multi search api will execute
Declaration
public long? MaxConcurrentSearches { get; set; }
Property Value
Type | Description |
---|---|
long? |
MaxConcurrentShardRequests
The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
Declaration
public long? MaxConcurrentShardRequests { get; set; }
Property Value
Type | Description |
---|---|
long? |
Operations
Declaration
public IDictionary<string, ISearchRequest> Operations { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, ISearchRequest> |
PreFilterShardSize
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 ie. 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
Search operation type
Declaration
public SearchType? SearchType { get; set; }
Property Value
Type | Description |
---|---|
SearchType? |
Self
Declaration
protected IMultiSearchRequest Self { get; }
Property Value
Type | Description |
---|---|
IMultiSearchRequest |
TotalHitsAsInteger
Indicates whether hits.total should be rendered as an integer or an object in the rest search response
Declaration
public bool? TotalHitsAsInteger { get; set; }
Property Value
Type | Description |
---|---|
bool? |
TypedKeys
Specify 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 SourceRequestDefaults(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 |