Search Results for

    Show / Hide Table of Contents

    Class RankEvalRequestParameters

    Request options for RankEval

    https://opensearch.org/docs/latest/api-reference/rank-eval/

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

    DefaultHttpMethod

    Declaration
    public override HttpMethod DefaultHttpMethod { get; }
    Property Value
    Type Description
    HttpMethod
    Overrides
    RequestParameters<RankEvalRequestParameters>.DefaultHttpMethod
    | Edit this page View Source

    ExpandWildcards

    Whether to expand wildcard expression to concrete indexes that are open, closed or both.

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

    IgnoreUnavailable

    If true, missing or closed indexes are not included in the response.

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

    SearchType

    Search operation type.

    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<RankEvalRequestParameters>.SupportsBody

    Implements

    IRequestParameters

    Extension Methods

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