Search Results for

    Show / Hide Table of Contents

    Class GeoShapeAttribute

    Maps a property as a geo_shape field

    Inheritance
    object
    Attribute
    OpenSearchPropertyAttributeBase
    OpenSearchCorePropertyAttributeBase
    OpenSearchDocValuesPropertyAttributeBase
    GeoShapeAttribute
    Implements
    IPropertyMapping
    IGeoShapeProperty
    IDocValuesProperty
    ICoreProperty
    IProperty
    IFieldMapping
    Inherited Members
    OpenSearchDocValuesPropertyAttributeBase.DocValues
    OpenSearchDocValuesPropertyAttributeBase.From(MemberInfo)
    OpenSearchCorePropertyAttributeBase.Similarity
    OpenSearchCorePropertyAttributeBase.Store
    OpenSearchPropertyAttributeBase.AllowPrivate
    OpenSearchPropertyAttributeBase.Ignore
    OpenSearchPropertyAttributeBase.Name
    OpenSearchPropertyAttributeBase.Order
    Attribute.Equals(object)
    Attribute.GetCustomAttribute(Assembly, Type)
    Attribute.GetCustomAttribute(Assembly, Type, bool)
    Attribute.GetCustomAttribute(MemberInfo, Type)
    Attribute.GetCustomAttribute(MemberInfo, Type, bool)
    Attribute.GetCustomAttribute(Module, Type)
    Attribute.GetCustomAttribute(Module, Type, bool)
    Attribute.GetCustomAttribute(ParameterInfo, Type)
    Attribute.GetCustomAttribute(ParameterInfo, Type, bool)
    Attribute.GetCustomAttributes(Assembly)
    Attribute.GetCustomAttributes(Assembly, bool)
    Attribute.GetCustomAttributes(Assembly, Type)
    Attribute.GetCustomAttributes(Assembly, Type, bool)
    Attribute.GetCustomAttributes(MemberInfo)
    Attribute.GetCustomAttributes(MemberInfo, bool)
    Attribute.GetCustomAttributes(MemberInfo, Type)
    Attribute.GetCustomAttributes(MemberInfo, Type, bool)
    Attribute.GetCustomAttributes(Module)
    Attribute.GetCustomAttributes(Module, bool)
    Attribute.GetCustomAttributes(Module, Type)
    Attribute.GetCustomAttributes(Module, Type, bool)
    Attribute.GetCustomAttributes(ParameterInfo)
    Attribute.GetCustomAttributes(ParameterInfo, bool)
    Attribute.GetCustomAttributes(ParameterInfo, Type)
    Attribute.GetCustomAttributes(ParameterInfo, Type, bool)
    Attribute.GetHashCode()
    Attribute.IsDefaultAttribute()
    Attribute.IsDefined(Assembly, Type)
    Attribute.IsDefined(Assembly, Type, bool)
    Attribute.IsDefined(MemberInfo, Type)
    Attribute.IsDefined(MemberInfo, Type, bool)
    Attribute.IsDefined(Module, Type)
    Attribute.IsDefined(Module, Type, bool)
    Attribute.IsDefined(ParameterInfo, Type)
    Attribute.IsDefined(ParameterInfo, Type, bool)
    Attribute.Match(object)
    Attribute.TypeId
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public class GeoShapeAttribute : OpenSearchDocValuesPropertyAttributeBase, IPropertyMapping, IGeoShapeProperty, IDocValuesProperty, ICoreProperty, IProperty, IFieldMapping

    Constructors

    | Edit this page View Source

    GeoShapeAttribute()

    Declaration
    public GeoShapeAttribute()

    Properties

    | Edit this page View Source

    Coerce

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

    Declaration
    public bool Coerce { get; set; }
    Property Value
    Type Description
    bool
    | Edit this page View Source

    IgnoreMalformed

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

    Declaration
    public bool IgnoreMalformed { get; set; }
    Property Value
    Type Description
    bool
    | Edit this page View Source

    IgnoreZValue

    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 bool IgnoreZValue { get; set; }
    Property Value
    Type Description
    bool
    | Edit this page View Source

    Orientation

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

    Declaration
    public GeoOrientation Orientation { get; set; }
    Property Value
    Type Description
    GeoOrientation
    | Edit this page View Source

    Strategy

    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 GeoStrategy Strategy { get; set; }
    Property Value
    Type Description
    GeoStrategy

    Implements

    IPropertyMapping
    IGeoShapeProperty
    IDocValuesProperty
    ICoreProperty
    IProperty
    IFieldMapping

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • GeoShapeAttribute()
    • Properties
      • Coerce
      • IgnoreMalformed
      • IgnoreZValue
      • Orientation
      • Strategy
    • Implements
    • Extension Methods
    Back to top Generated by DocFX