Class GeoShapePropertyDescriptor<T>

Maps a property as a geo_shape field

Inheritance
object
DescriptorBase<GeoShapePropertyDescriptor<T>, IGeoShapeProperty>
PropertyDescriptorBase<GeoShapePropertyDescriptor<T>, IGeoShapeProperty, T>
CorePropertyDescriptorBase<GeoShapePropertyDescriptor<T>, IGeoShapeProperty, T>
DocValuesPropertyDescriptorBase<GeoShapePropertyDescriptor<T>, IGeoShapeProperty, T>
GeoShapePropertyDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GeoShapePropertyDescriptor<T> : DocValuesPropertyDescriptorBase<GeoShapePropertyDescriptor<T>, IGeoShapeProperty, T>, IDescriptor, IGeoShapeProperty, IDocValuesProperty, ICoreProperty, IProperty, IFieldMapping where T : class
Type Parameters
Name Description
T

Constructors

| Edit this page View Source

GeoShapePropertyDescriptor()

Declaration
public GeoShapePropertyDescriptor()

Methods

| Edit this page View Source

Coerce(bool?)

Should the data be coerced into becoming a valid geo shape (for instance closing a polygon)

Declaration
public GeoShapePropertyDescriptor<T> Coerce(bool? coerce = true)
Parameters
Type Name Description
bool? coerce
Returns
Type Description
GeoShapePropertyDescriptor<T>
| Edit this page View Source

IgnoreMalformed(bool?)

If true, malformed geojson shapes are ignored. If false (default), malformed geojson shapes throw an exception and reject the whole document.

Declaration
public GeoShapePropertyDescriptor<T> IgnoreMalformed(bool? ignoreMalformed = true)
Parameters
Type Name Description
bool? ignoreMalformed
Returns
Type Description
GeoShapePropertyDescriptor<T>
| Edit this page View Source

IgnoreZValue(bool?)

If true (default) three dimension points will be accepted (stored in source) but only latitude and longitude values will be indexed; the third dimension is ignored. If false, geo-points containing any more than latitude and longitude (two dimensions) values throw an exception and reject the whole document.

Declaration
public GeoShapePropertyDescriptor<T> IgnoreZValue(bool? ignoreZValue = true)
Parameters
Type Name Description
bool? ignoreZValue
Returns
Type Description
GeoShapePropertyDescriptor<T>
| Edit this page View Source

Orientation(GeoOrientation?)

Defines how to interpret vertex order for polygons and multipolygons. Defaults to CounterClockWise

Declaration
public GeoShapePropertyDescriptor<T> Orientation(GeoOrientation? orientation)
Parameters
Type Name Description
GeoOrientation? orientation
Returns
Type Description
GeoShapePropertyDescriptor<T>
| Edit this page View Source

Strategy(GeoStrategy?)

Defines the approach for how to represent shapes at indexing and search time. It also influences the capabilities available so it is recommended to let OpenSearch set this parameter automatically.

Declaration
public GeoShapePropertyDescriptor<T> Strategy(GeoStrategy? strategy)
Parameters
Type Name Description
GeoStrategy? strategy
Returns
Type Description
GeoShapePropertyDescriptor<T>

Implements

Extension Methods