Class CountRequestParameters

Request options for Count

https://opensearch.org/docs/latest/api-reference/count/

Inheritance

object

RequestParameters<CountRequestParameters>

CountRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<CountRequestParameters>.CustomResponseBuilder

RequestParameters<CountRequestParameters>.QueryString

RequestParameters<CountRequestParameters>.RequestConfiguration

RequestParameters<CountRequestParameters>.ContainsQueryString(string)

RequestParameters<CountRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<CountRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<CountRequestParameters>.SetQueryString(string, object)

RequestParameters<CountRequestParameters>.Q<TOut>(string)

RequestParameters<CountRequestParameters>.Q(string, object)

RequestParameters<CountRequestParameters>.SetAcceptHeader(string)

RequestParameters<CountRequestParameters>.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 CountRequestParameters : RequestParameters<CountRequestParameters>, IRequestParameters

Properties

AllowNoIndices

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

Declaration

public bool? AllowNoIndices { get; set; }

Property Value

Type	Description
bool?

AnalyzeWildcard

If true, wildcard and prefix queries are analyzed. This parameter can only be used when the q query string parameter is specified.

Declaration

public bool? AnalyzeWildcard { get; set; }

Property Value

Type	Description
bool?

Analyzer

Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified.

Declaration

public string Analyzer { get; set; }

Property Value

Type	Description
string

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<CountRequestParameters>.DefaultHttpMethod

DefaultOperator

The default operator for query string query: AND or OR. This parameter can only be used when the q query string parameter is specified.

Declaration

public DefaultOperator? DefaultOperator { get; set; }

Property Value

Type	Description
DefaultOperator?

Df

Field to use as default where no field prefix is given in the query string. This parameter can only be used when the q query string parameter is specified.

Declaration

public string Df { get; set; }

Property Value

Type	Description
string

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.

Declaration

public ExpandWildcards? ExpandWildcards { get; set; }

Property Value

Type	Description
ExpandWildcards?

IgnoreThrottled

If true, concrete, expanded or aliased indices are ignored when frozen.

Declaration

public bool? IgnoreThrottled { get; set; }

Property Value

Type	Description
bool?

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?

Lenient

If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.

Declaration

public bool? Lenient { get; set; }

Property Value

Type	Description
bool?

MinScore

Sets the minimum _score value that documents must have to be included in the result.

Declaration

public double? MinScore { get; set; }

Property Value

Type	Description
double?

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

QueryOnQueryString

Query in the Lucene query string syntax.

Declaration

public string QueryOnQueryString { get; set; }

Property Value

Type	Description
string

Routing

Custom value used to route operations to a specific shard.

Declaration

public string[] Routing { get; set; }

Property Value

Type	Description
string[]

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<CountRequestParameters>.SupportsBody

TerminateAfter

Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting.

Declaration

public long? TerminateAfter { get; set; }

Property Value

Type	Description
long?

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)