Class ShapeQueryDescriptor<T>

Inheritance
object
DescriptorBase<ShapeQueryDescriptor<T>, IShapeQuery>
QueryDescriptorBase<ShapeQueryDescriptor<T>, IShapeQuery>
FieldNameQueryDescriptorBase<ShapeQueryDescriptor<T>, IShapeQuery, T>
ShapeQueryDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ShapeQueryDescriptor<T> : FieldNameQueryDescriptorBase<ShapeQueryDescriptor<T>, IShapeQuery, T>, IDescriptor, IShapeQuery, IFieldNameQuery, IQuery where T : class
Type Parameters
Name Description
T

Properties

| 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
protected override bool Conditionless { get; }
Property Value
Type Description
bool
Overrides

Methods

| Edit this page View Source

IgnoreUnmapped(bool?)

Will ignore an unmapped field and will not match any documents for this query. This can be useful when querying multiple indexes which might have different mappings.

Declaration
public ShapeQueryDescriptor<T> IgnoreUnmapped(bool? ignoreUnmapped = true)
Parameters
Type Name Description
bool? ignoreUnmapped
Returns
Type Description
ShapeQueryDescriptor<T>
| Edit this page View Source

IndexedShape(Func<FieldLookupDescriptor<T>, IFieldLookup>)

Indexed geo shape to search with

Declaration
public ShapeQueryDescriptor<T> IndexedShape(Func<FieldLookupDescriptor<T>, IFieldLookup> selector)
Parameters
Type Name Description
Func<FieldLookupDescriptor<T>, IFieldLookup> selector
Returns
Type Description
ShapeQueryDescriptor<T>
| Edit this page View Source

Relation(ShapeRelation?)

Controls the spatial relation operator to use at search time.

Declaration
public ShapeQueryDescriptor<T> Relation(ShapeRelation? relation)
Parameters
Type Name Description
ShapeRelation? relation
Returns
Type Description
ShapeQueryDescriptor<T>
| Edit this page View Source

Shape(Func<GeoShapeDescriptor, IGeoShape>)

The geo shape to search with

Declaration
public ShapeQueryDescriptor<T> Shape(Func<GeoShapeDescriptor, IGeoShape> selector)
Parameters
Type Name Description
Func<GeoShapeDescriptor, IGeoShape> selector
Returns
Type Description
ShapeQueryDescriptor<T>

Implements

Extension Methods