Class GeoPointPropertyDescriptor<T>

Data type mapping to map a property as a geopoint

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

Constructors

| Edit this page View Source

GeoPointPropertyDescriptor()

Declaration
public GeoPointPropertyDescriptor()

Methods

| Edit this page View Source

IgnoreMalformed(bool?)

If true, malformed geo-points are ignored. If false (default), malformed geo-points throw an exception and reject the whole document.

Declaration
public GeoPointPropertyDescriptor<T> IgnoreMalformed(bool? ignoreMalformed = true)
Parameters
Type Name Description
bool? ignoreMalformed
Returns
Type Description
GeoPointPropertyDescriptor<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 GeoPointPropertyDescriptor<T> IgnoreZValue(bool? ignoreZValue = true)
Parameters
Type Name Description
bool? ignoreZValue
Returns
Type Description
GeoPointPropertyDescriptor<T>
| Edit this page View Source

NullValue(GeoLocation)

Accepts a geo_point value which is substituted for any explicit null values. Defaults to null, which means the field is treated as missing.

Declaration
public GeoPointPropertyDescriptor<T> NullValue(GeoLocation defaultValue)
Parameters
Type Name Description
GeoLocation defaultValue
Returns
Type Description
GeoPointPropertyDescriptor<T>

Implements

Extension Methods