Class BoolQueryDescriptor<T>

Inheritance

object

DescriptorBase<BoolQueryDescriptor<T>, IBoolQuery>

QueryDescriptorBase<BoolQueryDescriptor<T>, IBoolQuery>

BoolQueryDescriptor<T>

Implements

IDescriptor

IBoolQuery

IQuery

Inherited Members

QueryDescriptorBase<BoolQueryDescriptor<T>, IBoolQuery>.Conditionless

QueryDescriptorBase<BoolQueryDescriptor<T>, IBoolQuery>.Name(string)

QueryDescriptorBase<BoolQueryDescriptor<T>, IBoolQuery>.Boost(double?)

QueryDescriptorBase<BoolQueryDescriptor<T>, IBoolQuery>.Verbatim(bool)

QueryDescriptorBase<BoolQueryDescriptor<T>, IBoolQuery>.Strict(bool)

DescriptorBase<BoolQueryDescriptor<T>, IBoolQuery>.Self

DescriptorBase<BoolQueryDescriptor<T>, IBoolQuery>.Assign<TValue>(TValue, Action<IBoolQuery, TValue>)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class BoolQueryDescriptor<T> : QueryDescriptorBase<BoolQueryDescriptor<T>, IBoolQuery>, IDescriptor, IBoolQuery, IQuery where T : class

Type Parameters

Name	Description
T

Properties

Conditionless

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

Declaration

protected override bool Conditionless { get; }

Property Value

Type	Description
bool

Overrides

QueryDescriptorBase<BoolQueryDescriptor<T>, IBoolQuery>.Conditionless

Methods

Filter(params QueryContainer[])

The clause (query) which is to be used as a filter (in filter context).

Declaration

public BoolQueryDescriptor<T> Filter(params QueryContainer[] queries)

Parameters

Type	Name	Description
QueryContainer[]	queries

Returns

Type	Description
BoolQueryDescriptor<T>

Filter(IEnumerable<Func<QueryContainerDescriptor<T>, QueryContainer>>)

The clause (query) which is to be used as a filter (in filter context).

Declaration

public BoolQueryDescriptor<T> Filter(IEnumerable<Func<QueryContainerDescriptor<T>, QueryContainer>> queries)

Parameters

Type	Name	Description
IEnumerable<Func<QueryContainerDescriptor<T>, QueryContainer>>	queries

Returns

Type	Description
BoolQueryDescriptor<T>

Filter(params Func<QueryContainerDescriptor<T>, QueryContainer>[])

The clause (query) which is to be used as a filter (in filter context).

Declaration

public BoolQueryDescriptor<T> Filter(params Func<QueryContainerDescriptor<T>, QueryContainer>[] queries)

Parameters

Type	Name	Description
Func<QueryContainerDescriptor<T>, QueryContainer>[]	queries

Returns

Type	Description
BoolQueryDescriptor<T>

MinimumShouldMatch(MinimumShouldMatch)

Specifies a minimum number of the optional BooleanClauses which must be satisfied.

Declaration

public BoolQueryDescriptor<T> MinimumShouldMatch(MinimumShouldMatch minimumShouldMatches)

Parameters

Type	Name	Description
MinimumShouldMatch	minimumShouldMatches

Returns

Type	Description
BoolQueryDescriptor<T>

Must(params QueryContainer[])

The clause(s) that must appear in matching documents

Declaration

public BoolQueryDescriptor<T> Must(params QueryContainer[] queries)

Parameters

Type	Name	Description
QueryContainer[]	queries

Returns

Type	Description
BoolQueryDescriptor<T>

Must(IEnumerable<Func<QueryContainerDescriptor<T>, QueryContainer>>)

The clause(s) that must appear in matching documents

Declaration

public BoolQueryDescriptor<T> Must(IEnumerable<Func<QueryContainerDescriptor<T>, QueryContainer>> queries)

Parameters

Type	Name	Description
IEnumerable<Func<QueryContainerDescriptor<T>, QueryContainer>>	queries

Returns

Type	Description
BoolQueryDescriptor<T>

Must(params Func<QueryContainerDescriptor<T>, QueryContainer>[])

The clause(s) that must appear in matching documents

Declaration

public BoolQueryDescriptor<T> Must(params Func<QueryContainerDescriptor<T>, QueryContainer>[] queries)

Parameters

Type	Name	Description
Func<QueryContainerDescriptor<T>, QueryContainer>[]	queries

Returns

Type	Description
BoolQueryDescriptor<T>

MustNot(params QueryContainer[])

The clause (query) must not appear in the matching documents. Note that it is not possible to search on documents that only consists of a must_not clauses.

Declaration

public BoolQueryDescriptor<T> MustNot(params QueryContainer[] queries)

Parameters

Type	Name	Description
QueryContainer[]	queries

Returns

Type	Description
BoolQueryDescriptor<T>

MustNot(IEnumerable<Func<QueryContainerDescriptor<T>, QueryContainer>>)

The clause (query) must not appear in the matching documents. Note that it is not possible to search on documents that only consists of a must_not clauses.

Declaration

public BoolQueryDescriptor<T> MustNot(IEnumerable<Func<QueryContainerDescriptor<T>, QueryContainer>> queries)

Parameters

Type	Name	Description
IEnumerable<Func<QueryContainerDescriptor<T>, QueryContainer>>	queries

Returns

Type	Description
BoolQueryDescriptor<T>

MustNot(params Func<QueryContainerDescriptor<T>, QueryContainer>[])

The clause (query) must not appear in the matching documents. Note that it is not possible to search on documents that only consists of a must_not clauses.

Declaration

public BoolQueryDescriptor<T> MustNot(params Func<QueryContainerDescriptor<T>, QueryContainer>[] queries)

Parameters

Type	Name	Description
Func<QueryContainerDescriptor<T>, QueryContainer>[]	queries

Returns

Type	Description
BoolQueryDescriptor<T>

Should(params QueryContainer[])

The clause (query) should appear in the matching document. A boolean query with no must clauses, one or more should clauses must match a document. The minimum number of should clauses to match can be set using MinimumShouldMatch(MinimumShouldMatch).

Declaration

public BoolQueryDescriptor<T> Should(params QueryContainer[] queries)

Parameters

Type	Name	Description
QueryContainer[]	queries

Returns

Type	Description
BoolQueryDescriptor<T>

Should(IEnumerable<Func<QueryContainerDescriptor<T>, QueryContainer>>)

The clause (query) should appear in the matching document. A boolean query with no must clauses, one or more should clauses must match a document. The minimum number of should clauses to match can be set using MinimumShouldMatch(MinimumShouldMatch).

Declaration

public BoolQueryDescriptor<T> Should(IEnumerable<Func<QueryContainerDescriptor<T>, QueryContainer>> queries)

Parameters

Type	Name	Description
IEnumerable<Func<QueryContainerDescriptor<T>, QueryContainer>>	queries

Returns

Type	Description
BoolQueryDescriptor<T>

Should(params Func<QueryContainerDescriptor<T>, QueryContainer>[])

The clause (query) should appear in the matching document. A boolean query with no must clauses, one or more should clauses must match a document. The minimum number of should clauses to match can be set using MinimumShouldMatch(MinimumShouldMatch).

Declaration

public BoolQueryDescriptor<T> Should(params Func<QueryContainerDescriptor<T>, QueryContainer>[] queries)

Parameters

Type	Name	Description
Func<QueryContainerDescriptor<T>, QueryContainer>[]	queries

Returns

Type	Description
BoolQueryDescriptor<T>

Implements

IDescriptor

IBoolQuery

IQuery

Extension Methods

SuffixExtensions.Suffix(object, string)