Search Results for

    Show / Hide Table of Contents

    Class PropertyDescriptorBase<TDescriptor, TInterface, T>

    A mapping for a property type to a document field in OpenSearch

    Inheritance
    object
    DescriptorBase<TDescriptor, TInterface>
    PropertyDescriptorBase<TDescriptor, TInterface, T>
    CorePropertyDescriptorBase<TDescriptor, TInterface, T>
    FieldAliasPropertyDescriptor<T>
    JoinPropertyDescriptor<T>
    PercolatorPropertyDescriptor<T>
    RankFeaturePropertyDescriptor<T>
    RankFeaturesPropertyDescriptor<T>
    Implements
    IDescriptor
    IProperty
    IFieldMapping
    Inherited Members
    DescriptorBase<TDescriptor, TInterface>.Self
    DescriptorBase<TDescriptor, TInterface>.Assign<TValue>(TValue, Action<TInterface, TValue>)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public abstract class PropertyDescriptorBase<TDescriptor, TInterface, T> : DescriptorBase<TDescriptor, TInterface>, IDescriptor, IProperty, IFieldMapping where TDescriptor : PropertyDescriptorBase<TDescriptor, TInterface, T>, TInterface where TInterface : class, IProperty where T : class
    Type Parameters
    Name Description
    TDescriptor
    TInterface
    T

    Constructors

    | Edit this page View Source

    PropertyDescriptorBase(FieldType)

    Declaration
    protected PropertyDescriptorBase(FieldType type)
    Parameters
    Type Name Description
    FieldType type

    Properties

    | Edit this page View Source

    DebugDisplay

    Declaration
    protected string DebugDisplay { get; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    TypeOverride

    Declaration
    protected string TypeOverride { set; }
    Property Value
    Type Description
    string

    Methods

    | Edit this page View Source

    LocalMetadata(Func<FluentDictionary<string, object>, FluentDictionary<string, object>>)

    Local property metadata that will not be stored in OpenSearch with the mappings

    Declaration
    public TDescriptor LocalMetadata(Func<FluentDictionary<string, object>, FluentDictionary<string, object>> selector)
    Parameters
    Type Name Description
    Func<FluentDictionary<string, object>, FluentDictionary<string, object>> selector
    Returns
    Type Description
    TDescriptor
    | Edit this page View Source

    Meta(Func<FluentDictionary<string, string>, FluentDictionary<string, string>>)

    Metadata attached to the field. This metadata is stored in but opaque to OpenSearch. It is only useful for multiple applications that work on the same indices to share meta information about fields such as units.

    Field metadata enforces at most 5 entries, that keys have a length that is less than or equal to 20, and that values are strings whose length is less than or equal to 50.
    Declaration
    public TDescriptor Meta(Func<FluentDictionary<string, string>, FluentDictionary<string, string>> selector)
    Parameters
    Type Name Description
    Func<FluentDictionary<string, string>, FluentDictionary<string, string>> selector
    Returns
    Type Description
    TDescriptor
    | Edit this page View Source

    Name(PropertyName)

    The name of the property

    Declaration
    public TDescriptor Name(PropertyName name)
    Parameters
    Type Name Description
    PropertyName name
    Returns
    Type Description
    TDescriptor
    | Edit this page View Source

    Name<TValue>(Expression<Func<T, TValue>>)

    The name of the property

    Declaration
    public TDescriptor Name<TValue>(Expression<Func<T, TValue>> objectPath)
    Parameters
    Type Name Description
    Expression<Func<T, TValue>> objectPath
    Returns
    Type Description
    TDescriptor
    Type Parameters
    Name Description
    TValue

    Implements

    IDescriptor
    IProperty
    IFieldMapping

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • PropertyDescriptorBase(FieldType)
    • Properties
      • DebugDisplay
      • TypeOverride
    • Methods
      • LocalMetadata(Func<FluentDictionary<string, object>, FluentDictionary<string, object>>)
      • Meta(Func<FluentDictionary<string, string>, FluentDictionary<string, string>>)
      • Name(PropertyName)
      • Name<TValue>(Expression<Func<T, TValue>>)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX