Search Results for

    Show / Hide Table of Contents

    Class SearchRequestParameters

    Request options for Search

    https://opensearch.org/docs/latest/im-plugin/index-transforms/transforms-apis/#get-a-transform-jobs-details

    Inheritance
    object
    RequestParameters<SearchRequestParameters>
    SearchRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<SearchRequestParameters>.CustomResponseBuilder
    RequestParameters<SearchRequestParameters>.QueryString
    RequestParameters<SearchRequestParameters>.RequestConfiguration
    RequestParameters<SearchRequestParameters>.ContainsQueryString(string)
    RequestParameters<SearchRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<SearchRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<SearchRequestParameters>.SetQueryString(string, object)
    RequestParameters<SearchRequestParameters>.Q<TOut>(string)
    RequestParameters<SearchRequestParameters>.Q(string, object)
    RequestParameters<SearchRequestParameters>.SetAcceptHeader(string)
    RequestParameters<SearchRequestParameters>.AcceptHeaderFromFormat(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Net.Specification.TransformsApi
    Assembly: OpenSearch.Net.dll
    Syntax
    public class SearchRequestParameters : RequestParameters<SearchRequestParameters>, IRequestParameters

    Properties

    | Edit this page View Source

    DefaultHttpMethod

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

    Search

    The search term to use to filter results.

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

    SortDirection

    Specifies the direction to sort results in. Can be ASC or DESC. Default is ASC.

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

    SortField

    The field to sort results with.

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

    SupportsBody

    Declaration
    public override bool SupportsBody { get; }
    Property Value
    Type Description
    bool
    Overrides
    RequestParameters<SearchRequestParameters>.SupportsBody

    Implements

    IRequestParameters

    Extension Methods

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