Class KeywordPropertyDescriptor<T>

A field to index structured content such as IDs, email addresses, hostnames, status codes, zip codes or tags. Used for filtering, sorting, and for aggregations.

Keyword fields are only searchable by their exact value.
Inheritance
object
DescriptorBase<KeywordPropertyDescriptor<T>, IKeywordProperty>
PropertyDescriptorBase<KeywordPropertyDescriptor<T>, IKeywordProperty, T>
CorePropertyDescriptorBase<KeywordPropertyDescriptor<T>, IKeywordProperty, T>
DocValuesPropertyDescriptorBase<KeywordPropertyDescriptor<T>, IKeywordProperty, T>
KeywordPropertyDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class KeywordPropertyDescriptor<T> : DocValuesPropertyDescriptorBase<KeywordPropertyDescriptor<T>, IKeywordProperty, T>, IDescriptor, IKeywordProperty, IDocValuesProperty, ICoreProperty, IProperty, IFieldMapping where T : class
Type Parameters
Name Description
T

Constructors

| Edit this page View Source

KeywordPropertyDescriptor()

Declaration
public KeywordPropertyDescriptor()

Methods

| Edit this page View Source

Boost(double?)

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

EagerGlobalOrdinals(bool?)

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

IgnoreAbove(int?)

Declaration
public KeywordPropertyDescriptor<T> IgnoreAbove(int? ignoreAbove)
Parameters
Type Name Description
int? ignoreAbove
Returns
Type Description
KeywordPropertyDescriptor<T>
| Edit this page View Source

Index(bool?)

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

IndexOptions(IndexOptions?)

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

Normalizer(string)

Declaration
public KeywordPropertyDescriptor<T> Normalizer(string normalizer)
Parameters
Type Name Description
string normalizer
Returns
Type Description
KeywordPropertyDescriptor<T>
| Edit this page View Source

Norms(bool?)

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

NullValue(string)

Declaration
public KeywordPropertyDescriptor<T> NullValue(string nullValue)
Parameters
Type Name Description
string nullValue
Returns
Type Description
KeywordPropertyDescriptor<T>
| Edit this page View Source

SplitQueriesOnWhitespace(bool?)

Whether full text queries should split the input on whitespace when building a query for this field.

Declaration
public KeywordPropertyDescriptor<T> SplitQueriesOnWhitespace(bool? split = true)
Parameters
Type Name Description
bool? split
Returns
Type Description
KeywordPropertyDescriptor<T>

Implements

Extension Methods