Search Results for

    Show / Hide Table of Contents

    Class SearchTemplateRequestParameters

    Request options for SearchTemplate

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

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

    Properties

    | Edit this page View Source

    AllowNoIndices

    If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

    Declaration
    public bool? AllowNoIndices { get; set; }
    Property Value
    Type Description
    bool?
    | 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<SearchTemplateRequestParameters>.DefaultHttpMethod
    | Edit this page View Source

    ExpandWildcards

    Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

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

    Explain

    If true, the response includes additional details about score computation as part of a hit.

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

    IgnoreThrottled

    If true, specified concrete, expanded, or aliased indexes are not included in the response when throttled.

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

    IgnoreUnavailable

    If false, the request returns an error if it targets a missing or closed index.

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

    Preference

    Specifies the node or shard the operation should be performed on. Random by default.

    Declaration
    public string Preference { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    Profile

    If true, the query execution is profiled.

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

    Routing

    Custom value used to route operations to a specific shard.

    Declaration
    public string[] Routing { get; set; }
    Property Value
    Type Description
    string[]
    | Edit this page View Source

    Scroll

    Specifies how long a consistent view of the index should be maintained for scrolled search.

    Declaration
    public TimeSpan Scroll { get; set; }
    Property Value
    Type Description
    TimeSpan
    | Edit this page View Source

    SearchType

    The type of the search operation.

    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<SearchTemplateRequestParameters>.SupportsBody
    | Edit this page View Source

    TotalHitsAsInteger

    If true, hits.total are rendered as an integer in the response.

    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
      • AllowNoIndices
      • CcsMinimizeRoundtrips
      • DefaultHttpMethod
      • ExpandWildcards
      • Explain
      • IgnoreThrottled
      • IgnoreUnavailable
      • Preference
      • Profile
      • Routing
      • Scroll
      • SearchType
      • SupportsBody
      • TotalHitsAsInteger
      • TypedKeys
    • Implements
    • Extension Methods
    Back to top Generated by DocFX