Class MultiSearchTemplateRequest
Request for MultiSearchTemplate
https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/
Inheritance
MultiSearchTemplateRequest
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class MultiSearchTemplateRequest : PlainRequestBase<MultiSearchTemplateRequestParameters>, IMultiSearchTemplateRequest, IRequest<MultiSearchTemplateRequestParameters>, IRequest
Constructors
| Edit this page View SourceMultiSearchTemplateRequest()
/_msearch/template
Declaration
public MultiSearchTemplateRequest()
MultiSearchTemplateRequest(Indices)
/{index}/_msearch/template
Declaration
public MultiSearchTemplateRequest(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? |
Operations
Declaration
public IDictionary<string, ISearchTemplateRequest> Operations { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, ISearchTemplateRequest> |
SearchType
Search operation type
Declaration
public SearchType? SearchType { get; set; }
Property Value
Type | Description |
---|---|
SearchType? |
Self
Declaration
protected IMultiSearchTemplateRequest Self { get; }
Property Value
Type | Description |
---|---|
IMultiSearchTemplateRequest |
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(MultiSearchTemplateRequestParameters)
Allows a request implementation to set certain request parameter defaults, use sparingly!
Declaration
protected override sealed void RequestDefaults(MultiSearchTemplateRequestParameters parameters)
Parameters
Type | Name | Description |
---|---|---|
MultiSearchTemplateRequestParameters | parameters |