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
Inherited Members
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

Extension Methods