Class SearchRequestParameters

Request options for Search

<p>https://docs.opensearch.org/latest/im-plugin/index-transforms/transforms-apis/#get-a-transform-jobs-details</p>
Inheritance
object
RequestParameters<SearchRequestParameters>
SearchRequestParameters
Implements
Inherited Members
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
| Edit this page View Source

OperationName

The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

Declaration
public override string OperationName { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

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

Implements

Extension Methods