Search Results for

    Show / Hide Table of Contents

    Class MultiSearchTemplateRequestParameters

    Request options for MultiSearchTemplate

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

    Inheritance
    object
    RequestParameters<MultiSearchTemplateRequestParameters>
    MultiSearchTemplateRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<MultiSearchTemplateRequestParameters>.CustomResponseBuilder
    RequestParameters<MultiSearchTemplateRequestParameters>.QueryString
    RequestParameters<MultiSearchTemplateRequestParameters>.RequestConfiguration
    RequestParameters<MultiSearchTemplateRequestParameters>.ContainsQueryString(string)
    RequestParameters<MultiSearchTemplateRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<MultiSearchTemplateRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<MultiSearchTemplateRequestParameters>.SetQueryString(string, object)
    RequestParameters<MultiSearchTemplateRequestParameters>.Q<TOut>(string)
    RequestParameters<MultiSearchTemplateRequestParameters>.Q(string, object)
    RequestParameters<MultiSearchTemplateRequestParameters>.SetAcceptHeader(string)
    RequestParameters<MultiSearchTemplateRequestParameters>.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 MultiSearchTemplateRequestParameters : RequestParameters<MultiSearchTemplateRequestParameters>, IRequestParameters

    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

    DefaultHttpMethod

    Declaration
    public override HttpMethod DefaultHttpMethod { get; }
    Property Value
    Type Description
    HttpMethod
    Overrides
    RequestParameters<MultiSearchTemplateRequestParameters>.DefaultHttpMethod
    | 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

    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

    SupportsBody

    Declaration
    public override bool SupportsBody { get; }
    Property Value
    Type Description
    bool
    Overrides
    RequestParameters<MultiSearchTemplateRequestParameters>.SupportsBody
    | 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?

    Implements

    IRequestParameters

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • CcsMinimizeRoundtrips
      • DefaultHttpMethod
      • MaxConcurrentSearches
      • SearchType
      • SupportsBody
      • TotalHitsAsInteger
      • TypedKeys
    • Implements
    • Extension Methods
    Back to top Generated by DocFX