Search Results for

    Show / Hide Table of Contents

    Class CorePropertyDescriptorBase<TDescriptor, TInterface, T>

    Core properties of 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>
    DocValuesPropertyDescriptorBase<TDescriptor, TInterface, T>
    ObjectPropertyDescriptorBase<TDescriptor, TInterface, TParent, TChild>
    SearchAsYouTypePropertyDescriptor<T>
    TextPropertyDescriptor<T>
    Implements
    IDescriptor
    ICoreProperty
    IProperty
    IFieldMapping
    Inherited Members
    PropertyDescriptorBase<TDescriptor, TInterface, T>.DebugDisplay
    PropertyDescriptorBase<TDescriptor, TInterface, T>.TypeOverride
    PropertyDescriptorBase<TDescriptor, TInterface, T>.Name(PropertyName)
    PropertyDescriptorBase<TDescriptor, TInterface, T>.Name<TValue>(Expression<Func<T, TValue>>)
    PropertyDescriptorBase<TDescriptor, TInterface, T>.LocalMetadata(Func<FluentDictionary<string, object>, FluentDictionary<string, object>>)
    PropertyDescriptorBase<TDescriptor, TInterface, T>.Meta(Func<FluentDictionary<string, string>, FluentDictionary<string, string>>)
    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 CorePropertyDescriptorBase<TDescriptor, TInterface, T> : PropertyDescriptorBase<TDescriptor, TInterface, T>, IDescriptor, ICoreProperty, IProperty, IFieldMapping where TDescriptor : CorePropertyDescriptorBase<TDescriptor, TInterface, T>, TInterface where TInterface : class, ICoreProperty where T : class
    Type Parameters
    Name Description
    TDescriptor
    TInterface
    T

    Constructors

    | Edit this page View Source

    CorePropertyDescriptorBase(FieldType)

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

    Methods

    | Edit this page View Source

    CopyTo(Func<FieldsDescriptor<T>, IPromise<Fields>>)

    Copies the value of this field into another field, which can be queried as a single field. Allows for the creation of custom _all fields

    Declaration
    public TDescriptor CopyTo(Func<FieldsDescriptor<T>, IPromise<Fields>> fields)
    Parameters
    Type Name Description
    Func<FieldsDescriptor<T>, IPromise<Fields>> fields
    Returns
    Type Description
    TDescriptor
    | Edit this page View Source

    Fields(Func<PropertiesDescriptor<T>, IPromise<IProperties>>)

    Configures multi-fields for this field. Allows one field to be indexed in different ways to serve different search and analytics purposes

    Declaration
    public TDescriptor Fields(Func<PropertiesDescriptor<T>, IPromise<IProperties>> selector)
    Parameters
    Type Name Description
    Func<PropertiesDescriptor<T>, IPromise<IProperties>> selector
    Returns
    Type Description
    TDescriptor
    | Edit this page View Source

    Similarity(string)

    Which relevancy scoring algorithm or similarity should be used. Defaults to BM25

    Declaration
    public TDescriptor Similarity(string similarity)
    Parameters
    Type Name Description
    string similarity
    Returns
    Type Description
    TDescriptor
    | Edit this page View Source

    Store(bool?)

    Whether the field value should be stored and retrievable separately from the _source field Default is false.

    Declaration
    public TDescriptor Store(bool? store = true)
    Parameters
    Type Name Description
    bool? store
    Returns
    Type Description
    TDescriptor
    Remarks

    Not valid on ObjectProperty

    Implements

    IDescriptor
    ICoreProperty
    IProperty
    IFieldMapping

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • CorePropertyDescriptorBase(FieldType)
    • Methods
      • CopyTo(Func<FieldsDescriptor<T>, IPromise<Fields>>)
      • Fields(Func<PropertiesDescriptor<T>, IPromise<IProperties>>)
      • Similarity(string)
      • Store(bool?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX