Search Results for

    Show / Hide Table of Contents

    Class KeywordProperty

    A field to index structured content such as IDs, email addresses, hostnames, status codes, zip codes or tags. Used for filtering, sorting, and for aggregations.

    Keyword fields are only searchable by their exact value.
    Inheritance
    object
    PropertyBase
    CorePropertyBase
    DocValuesPropertyBase
    KeywordProperty
    Implements
    IPropertyWithClrOrigin
    IKeywordProperty
    IDocValuesProperty
    ICoreProperty
    IProperty
    IFieldMapping
    Inherited Members
    DocValuesPropertyBase.DocValues
    CorePropertyBase.CopyTo
    CorePropertyBase.Fields
    CorePropertyBase.Similarity
    CorePropertyBase.Store
    PropertyBase.LocalMetadata
    PropertyBase.Meta
    PropertyBase.Name
    PropertyBase.DebugDisplay
    PropertyBase.ToString()
    PropertyBase.TypeOverride
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public class KeywordProperty : DocValuesPropertyBase, IPropertyWithClrOrigin, IKeywordProperty, IDocValuesProperty, ICoreProperty, IProperty, IFieldMapping

    Constructors

    | Edit this page View Source

    KeywordProperty()

    Declaration
    public KeywordProperty()

    Properties

    | Edit this page View Source

    Boost

    Declaration
    public double? Boost { get; set; }
    Property Value
    Type Description
    double?
    | Edit this page View Source

    EagerGlobalOrdinals

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

    IgnoreAbove

    Declaration
    public int? IgnoreAbove { get; set; }
    Property Value
    Type Description
    int?
    | Edit this page View Source

    Index

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

    IndexOptions

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

    Normalizer

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

    Norms

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

    NullValue

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

    SplitQueriesOnWhitespace

    Whether full text queries should split the input on whitespace when building a query for this field.

    Declaration
    public bool? SplitQueriesOnWhitespace { get; set; }
    Property Value
    Type Description
    bool?

    Implements

    IPropertyWithClrOrigin
    IKeywordProperty
    IDocValuesProperty
    ICoreProperty
    IProperty
    IFieldMapping

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • KeywordProperty()
    • Properties
      • Boost
      • EagerGlobalOrdinals
      • IgnoreAbove
      • Index
      • IndexOptions
      • Normalizer
      • Norms
      • NullValue
      • SplitQueriesOnWhitespace
    • Implements
    • Extension Methods
    Back to top Generated by DocFX