Interface IQuery

Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IQuery

Properties

| Edit this page View Source

Boost

Provides a boost to this query to influence its relevance score. For example, a query with a boost of 2 is twice as important as a query with a boost of 1, although the actual boost value that is applied undergoes normalization and internal optimization.

Declaration
[DataMember(Name = "boost")]
double? Boost { get; set; }
Property Value
Type Description
double?
Remarks

Setting a boost for an ISpanOrQuery query will throw a parsing exception on the server.

| Edit this page View Source

Conditionless

Whether the query is conditionless. A conditionless query is not serialized as part of the request sent to OpenSearch.

Declaration
[IgnoreDataMember]
bool Conditionless { get; }
Property Value
Type Description
bool
| Edit this page View Source

IsStrict

Whether the query should be treated as strict. A strict query will throw an exception when serialized if it is Conditionless.

Declaration
[IgnoreDataMember]
bool IsStrict { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

IsVerbatim

Whether the query should be treated as verbatim. A verbatim query will be serialized as part of the request, irrespective of whether it is Conditionless or not.

Declaration
[IgnoreDataMember]
bool IsVerbatim { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

IsWritable

Whether the query should be treated as writable. Used when determining how to combine queries.

Declaration
[IgnoreDataMember]
bool IsWritable { get; }
Property Value
Type Description
bool
| Edit this page View Source

Name

The name of the query. Allows you to retrieve for each document what part of the query it matched on.

Declaration
[DataMember(Name = "_name")]
string Name { get; set; }
Property Value
Type Description
string

Extension Methods