Search Results for

    Show / Hide Table of Contents

    Class SearchTemplateRequest

    Request for SearchTemplate

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

    Inheritance
    object
    RequestBase<SearchTemplateRequestParameters>
    PlainRequestBase<SearchTemplateRequestParameters>
    SearchTemplateRequest
    SearchTemplateRequest<T>
    Implements
    ISearchTemplateRequest
    ITypedSearchRequest
    IRequest<SearchTemplateRequestParameters>
    IRequest
    Inherited Members
    PlainRequestBase<SearchTemplateRequestParameters>.RequestConfiguration
    PlainRequestBase<SearchTemplateRequestParameters>.ErrorTrace
    PlainRequestBase<SearchTemplateRequestParameters>.FilterPath
    PlainRequestBase<SearchTemplateRequestParameters>.Human
    PlainRequestBase<SearchTemplateRequestParameters>.Pretty
    PlainRequestBase<SearchTemplateRequestParameters>.SourceQueryString
    RequestBase<SearchTemplateRequestParameters>.HttpMethod
    RequestBase<SearchTemplateRequestParameters>.RequestState
    RequestBase<SearchTemplateRequestParameters>.ContentType
    RequestBase<SearchTemplateRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<SearchTemplateRequestParameters>.Q<TOut>(string)
    RequestBase<SearchTemplateRequestParameters>.Q(string, object)
    RequestBase<SearchTemplateRequestParameters>.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 SearchTemplateRequest : PlainRequestBase<SearchTemplateRequestParameters>, ISearchTemplateRequest, ITypedSearchRequest, IRequest<SearchTemplateRequestParameters>, IRequest

    Constructors

    | Edit this page View Source

    SearchTemplateRequest()

    /_search/template

    Declaration
    public SearchTemplateRequest()
    | Edit this page View Source

    SearchTemplateRequest(Indices)

    /{index}/_search/template

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

    Optional, accepts null

    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

    ClrType

    Declaration
    protected Type ClrType { get; set; }
    Property Value
    Type Description
    Type
    | 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

    Id

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

    Params

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

    A document is routed to a particular shard in an index using the following formula

    shard_num = hash(_routing) % num_primary_shards

    OpenSearch will use the document id if not provided.

    For requests that are constructed from/for a document OpenSearch.Client will automatically infer the routing key if that document has a JoinField or a routing mapping on for its type exists on ConnectionSettings

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

    Scroll

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

    Declaration
    public Time Scroll { get; set; }
    Property Value
    Type Description
    Time
    | 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

    Self

    Declaration
    protected ISearchTemplateRequest Self { get; }
    Property Value
    Type Description
    ISearchTemplateRequest
    | Edit this page View Source

    Source

    Declaration
    public string Source { get; set; }
    Property Value
    Type Description
    string
    | 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?

    Methods

    | Edit this page View Source

    RequestDefaults(SearchTemplateRequestParameters)

    Allows a request implementation to set certain request parameter defaults, use sparingly!

    Declaration
    protected override sealed void RequestDefaults(SearchTemplateRequestParameters parameters)
    Parameters
    Type Name Description
    SearchTemplateRequestParameters parameters
    Overrides
    RequestBase<SearchTemplateRequestParameters>.RequestDefaults(SearchTemplateRequestParameters)

    Implements

    ISearchTemplateRequest
    ITypedSearchRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • SearchTemplateRequest()
      • SearchTemplateRequest(Indices)
    • Properties
      • AllowNoIndices
      • CcsMinimizeRoundtrips
      • ClrType
      • ExpandWildcards
      • Explain
      • Id
      • IgnoreThrottled
      • IgnoreUnavailable
      • Params
      • Preference
      • Profile
      • Routing
      • Scroll
      • SearchType
      • Self
      • Source
      • TotalHitsAsInteger
      • TypedKeys
    • Methods
      • RequestDefaults(SearchTemplateRequestParameters)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX