Search Results for

    Show / Hide Table of Contents

    Class MultiSearchTemplateRequest

    Request for MultiSearchTemplate

    https://opensearch.org/docs/latest/search-plugins/search-template/

    Inheritance
    object
    RequestBase<MultiSearchTemplateRequestParameters>
    PlainRequestBase<MultiSearchTemplateRequestParameters>
    MultiSearchTemplateRequest
    Implements
    IMultiSearchTemplateRequest
    IRequest<MultiSearchTemplateRequestParameters>
    IRequest
    Inherited Members
    PlainRequestBase<MultiSearchTemplateRequestParameters>.RequestConfiguration
    PlainRequestBase<MultiSearchTemplateRequestParameters>.ErrorTrace
    PlainRequestBase<MultiSearchTemplateRequestParameters>.FilterPath
    PlainRequestBase<MultiSearchTemplateRequestParameters>.Human
    PlainRequestBase<MultiSearchTemplateRequestParameters>.Pretty
    PlainRequestBase<MultiSearchTemplateRequestParameters>.SourceQueryString
    RequestBase<MultiSearchTemplateRequestParameters>.HttpMethod
    RequestBase<MultiSearchTemplateRequestParameters>.RequestState
    RequestBase<MultiSearchTemplateRequestParameters>.ContentType
    RequestBase<MultiSearchTemplateRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<MultiSearchTemplateRequestParameters>.Q<TOut>(string)
    RequestBase<MultiSearchTemplateRequestParameters>.Q(string, object)
    RequestBase<MultiSearchTemplateRequestParameters>.SetAcceptHeader(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public class MultiSearchTemplateRequest : PlainRequestBase<MultiSearchTemplateRequestParameters>, IMultiSearchTemplateRequest, IRequest<MultiSearchTemplateRequestParameters>, IRequest

    Constructors

    | Edit this page View Source

    MultiSearchTemplateRequest()

    /_msearch/template

    Declaration
    public MultiSearchTemplateRequest()
    | Edit this page View Source

    MultiSearchTemplateRequest(Indices)

    /{index}/_msearch/template

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

    Optional, accepts null

    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

    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

    Operations

    Declaration
    public IDictionary<string, ISearchTemplateRequest> Operations { get; set; }
    Property Value
    Type Description
    IDictionary<string, ISearchTemplateRequest>
    | 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

    Self

    Declaration
    protected IMultiSearchTemplateRequest Self { get; }
    Property Value
    Type Description
    IMultiSearchTemplateRequest
    | 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?

    Methods

    | Edit this page View Source

    RequestDefaults(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
    Overrides
    RequestBase<MultiSearchTemplateRequestParameters>.RequestDefaults(MultiSearchTemplateRequestParameters)

    Implements

    IMultiSearchTemplateRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • MultiSearchTemplateRequest()
      • MultiSearchTemplateRequest(Indices)
    • Properties
      • CcsMinimizeRoundtrips
      • MaxConcurrentSearches
      • Operations
      • SearchType
      • Self
      • TotalHitsAsInteger
      • TypedKeys
    • Methods
      • RequestDefaults(MultiSearchTemplateRequestParameters)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX