Class TextPropertyDescriptor<T>

A field to index full-text values, such as the body of an email or the description of a product. These fields are analyzed in OpenSearch, by passing through an analyzer to convert the string into a list of individual terms before being indexed.

Text fields are not used for sorting and seldom used for aggregations

Inheritance

object

DescriptorBase<TextPropertyDescriptor<T>, ITextProperty>

PropertyDescriptorBase<TextPropertyDescriptor<T>, ITextProperty, T>

CorePropertyDescriptorBase<TextPropertyDescriptor<T>, ITextProperty, T>

TextPropertyDescriptor<T>

Implements

IDescriptor

ITextProperty

ICoreProperty

IProperty

IFieldMapping

Inherited Members

CorePropertyDescriptorBase<TextPropertyDescriptor<T>, ITextProperty, T>.Store(bool?)

CorePropertyDescriptorBase<TextPropertyDescriptor<T>, ITextProperty, T>.Fields(Func<PropertiesDescriptor<T>, IPromise<IProperties>>)

CorePropertyDescriptorBase<TextPropertyDescriptor<T>, ITextProperty, T>.Similarity(string)

CorePropertyDescriptorBase<TextPropertyDescriptor<T>, ITextProperty, T>.CopyTo(Func<FieldsDescriptor<T>, IPromise<Fields>>)

PropertyDescriptorBase<TextPropertyDescriptor<T>, ITextProperty, T>.DebugDisplay

PropertyDescriptorBase<TextPropertyDescriptor<T>, ITextProperty, T>.TypeOverride

PropertyDescriptorBase<TextPropertyDescriptor<T>, ITextProperty, T>.Name(PropertyName)

PropertyDescriptorBase<TextPropertyDescriptor<T>, ITextProperty, T>.Name<TValue>(Expression<Func<T, TValue>>)

PropertyDescriptorBase<TextPropertyDescriptor<T>, ITextProperty, T>.LocalMetadata(Func<FluentDictionary<string, object>, FluentDictionary<string, object>>)

PropertyDescriptorBase<TextPropertyDescriptor<T>, ITextProperty, T>.Meta(Func<FluentDictionary<string, string>, FluentDictionary<string, string>>)

DescriptorBase<TextPropertyDescriptor<T>, ITextProperty>.Self

DescriptorBase<TextPropertyDescriptor<T>, ITextProperty>.Assign<TValue>(TValue, Action<ITextProperty, 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 class TextPropertyDescriptor<T> : CorePropertyDescriptorBase<TextPropertyDescriptor<T>, ITextProperty, T>, IDescriptor, ITextProperty, ICoreProperty, IProperty, IFieldMapping where T : class

Type Parameters

Name	Description
T

Constructors

TextPropertyDescriptor()

Declaration

public TextPropertyDescriptor()

Methods

Analyzer(string)

Declaration

public TextPropertyDescriptor<T> Analyzer(string analyzer)

Parameters

Type	Name	Description
string	analyzer

Returns

Type	Description
TextPropertyDescriptor<T>

Boost(double?)

Declaration

public TextPropertyDescriptor<T> Boost(double? boost)

Parameters

Type	Name	Description
double?	boost

Returns

Type	Description
TextPropertyDescriptor<T>

EagerGlobalOrdinals(bool?)

Declaration

public TextPropertyDescriptor<T> EagerGlobalOrdinals(bool? eagerGlobalOrdinals = true)

Parameters

Type	Name	Description
bool?	eagerGlobalOrdinals

Returns

Type	Description
TextPropertyDescriptor<T>

Fielddata(bool?)

Declaration

public TextPropertyDescriptor<T> Fielddata(bool? fielddata = true)

Parameters

Type	Name	Description
bool?	fielddata

Returns

Type	Description
TextPropertyDescriptor<T>

FielddataFrequencyFilter(Func<FielddataFrequencyFilterDescriptor, IFielddataFrequencyFilter>)

Declaration

public TextPropertyDescriptor<T> FielddataFrequencyFilter(Func<FielddataFrequencyFilterDescriptor, IFielddataFrequencyFilter> selector)

Parameters

Type	Name	Description
Func<FielddataFrequencyFilterDescriptor, IFielddataFrequencyFilter>	selector

Returns

Type	Description
TextPropertyDescriptor<T>

Index(bool?)

Declaration

public TextPropertyDescriptor<T> Index(bool? index = true)

Parameters

Type	Name	Description
bool?	index

Returns

Type	Description
TextPropertyDescriptor<T>

IndexOptions(IndexOptions?)

Declaration

public TextPropertyDescriptor<T> IndexOptions(IndexOptions? indexOptions)

Parameters

Type	Name	Description
IndexOptions?	indexOptions

Returns

Type	Description
TextPropertyDescriptor<T>

IndexPhrases(bool?)

Declaration

public TextPropertyDescriptor<T> IndexPhrases(bool? indexPhrases = true)

Parameters

Type	Name	Description
bool?	indexPhrases

Returns

Type	Description
TextPropertyDescriptor<T>

IndexPrefixes(Func<TextIndexPrefixesDescriptor, ITextIndexPrefixes>)

Declaration

public TextPropertyDescriptor<T> IndexPrefixes(Func<TextIndexPrefixesDescriptor, ITextIndexPrefixes> selector)

Parameters

Type	Name	Description
Func<TextIndexPrefixesDescriptor, ITextIndexPrefixes>	selector

Returns

Type	Description
TextPropertyDescriptor<T>

Norms(bool?)

Declaration

public TextPropertyDescriptor<T> Norms(bool? enabled = true)

Parameters

Type	Name	Description
bool?	enabled

Returns

Type	Description
TextPropertyDescriptor<T>

PositionIncrementGap(int?)

Declaration

public TextPropertyDescriptor<T> PositionIncrementGap(int? positionIncrementGap)

Parameters

Type	Name	Description
int?	positionIncrementGap

Returns

Type	Description
TextPropertyDescriptor<T>

SearchAnalyzer(string)

Declaration

public TextPropertyDescriptor<T> SearchAnalyzer(string searchAnalyzer)

Parameters

Type	Name	Description
string	searchAnalyzer

Returns

Type	Description
TextPropertyDescriptor<T>

SearchQuoteAnalyzer(string)

Declaration

public TextPropertyDescriptor<T> SearchQuoteAnalyzer(string searchQuoteAnalyzer)

Parameters

Type	Name	Description
string	searchQuoteAnalyzer

Returns

Type	Description
TextPropertyDescriptor<T>

TermVector(TermVectorOption?)

Declaration

public TextPropertyDescriptor<T> TermVector(TermVectorOption? termVector)

Parameters

Type	Name	Description
TermVectorOption?	termVector

Returns

Type	Description
TextPropertyDescriptor<T>

Implements

IDescriptor

ITextProperty

ICoreProperty

IProperty

IFieldMapping

Extension Methods

SuffixExtensions.Suffix(object, string)