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

| Edit this page View Source

TextPropertyDescriptor()

Declaration
public TextPropertyDescriptor()

Methods

| Edit this page View Source

Analyzer(string)

Declaration
public TextPropertyDescriptor<T> Analyzer(string analyzer)
Parameters
Type Name Description
string analyzer
Returns
Type Description
TextPropertyDescriptor<T>
| Edit this page View Source

Boost(double?)

Declaration
public TextPropertyDescriptor<T> Boost(double? boost)
Parameters
Type Name Description
double? boost
Returns
Type Description
TextPropertyDescriptor<T>
| Edit this page View Source

EagerGlobalOrdinals(bool?)

Declaration
public TextPropertyDescriptor<T> EagerGlobalOrdinals(bool? eagerGlobalOrdinals = true)
Parameters
Type Name Description
bool? eagerGlobalOrdinals
Returns
Type Description
TextPropertyDescriptor<T>
| Edit this page View Source

Fielddata(bool?)

Declaration
public TextPropertyDescriptor<T> Fielddata(bool? fielddata = true)
Parameters
Type Name Description
bool? fielddata
Returns
Type Description
TextPropertyDescriptor<T>
| Edit this page View Source

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>
| Edit this page View Source

Index(bool?)

Declaration
public TextPropertyDescriptor<T> Index(bool? index = true)
Parameters
Type Name Description
bool? index
Returns
Type Description
TextPropertyDescriptor<T>
| Edit this page View Source

IndexOptions(IndexOptions?)

Declaration
public TextPropertyDescriptor<T> IndexOptions(IndexOptions? indexOptions)
Parameters
Type Name Description
IndexOptions? indexOptions
Returns
Type Description
TextPropertyDescriptor<T>
| Edit this page View Source

IndexPhrases(bool?)

Declaration
public TextPropertyDescriptor<T> IndexPhrases(bool? indexPhrases = true)
Parameters
Type Name Description
bool? indexPhrases
Returns
Type Description
TextPropertyDescriptor<T>
| Edit this page View Source

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>
| Edit this page View Source

Norms(bool?)

Declaration
public TextPropertyDescriptor<T> Norms(bool? enabled = true)
Parameters
Type Name Description
bool? enabled
Returns
Type Description
TextPropertyDescriptor<T>
| Edit this page View Source

PositionIncrementGap(int?)

Declaration
public TextPropertyDescriptor<T> PositionIncrementGap(int? positionIncrementGap)
Parameters
Type Name Description
int? positionIncrementGap
Returns
Type Description
TextPropertyDescriptor<T>
| Edit this page View Source

SearchAnalyzer(string)

Declaration
public TextPropertyDescriptor<T> SearchAnalyzer(string searchAnalyzer)
Parameters
Type Name Description
string searchAnalyzer
Returns
Type Description
TextPropertyDescriptor<T>
| Edit this page View Source

SearchQuoteAnalyzer(string)

Declaration
public TextPropertyDescriptor<T> SearchQuoteAnalyzer(string searchQuoteAnalyzer)
Parameters
Type Name Description
string searchQuoteAnalyzer
Returns
Type Description
TextPropertyDescriptor<T>
| Edit this page View Source

TermVector(TermVectorOption?)

Declaration
public TextPropertyDescriptor<T> TermVector(TermVectorOption? termVector)
Parameters
Type Name Description
TermVectorOption? termVector
Returns
Type Description
TextPropertyDescriptor<T>

Implements

Extension Methods