Interface IPropertiesDescriptor<T, TReturnType>

Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IPropertiesDescriptor<T, out TReturnType> where T : class where TReturnType : class
Type Parameters
Name Description
T
TReturnType

Methods

| Edit this page View Source

Binary(Func<BinaryPropertyDescriptor<T>, IBinaryProperty>)

The binary type accepts a binary value as a Base64 encoded string. The field is not stored by default and is not searchable

Declaration
TReturnType Binary(Func<BinaryPropertyDescriptor<T>, IBinaryProperty> selector)
Parameters
Type Name Description
Func<BinaryPropertyDescriptor<T>, IBinaryProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Boolean(Func<BooleanPropertyDescriptor<T>, IBooleanProperty>)

The boolean fields accepts true and false values

Declaration
TReturnType Boolean(Func<BooleanPropertyDescriptor<T>, IBooleanProperty> selector)
Parameters
Type Name Description
Func<BooleanPropertyDescriptor<T>, IBooleanProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Completion(Func<CompletionPropertyDescriptor<T>, ICompletionProperty>)

Declaration
TReturnType Completion(Func<CompletionPropertyDescriptor<T>, ICompletionProperty> selector)
Parameters
Type Name Description
Func<CompletionPropertyDescriptor<T>, ICompletionProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Date(Func<DatePropertyDescriptor<T>, IDateProperty>)

The date datatype maps a field as a date in OpenSearch.

Declaration
TReturnType Date(Func<DatePropertyDescriptor<T>, IDateProperty> selector)
Parameters
Type Name Description
Func<DatePropertyDescriptor<T>, IDateProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

DateNanos(Func<DateNanosPropertyDescriptor<T>, IDateNanosProperty>)

The date nanos datatype is similar to IDateProperty, except that internally, the date is stored with nanosecond resolution. This limits its range of dates from roughly 1970 to 2262.

Declaration
TReturnType DateNanos(Func<DateNanosPropertyDescriptor<T>, IDateNanosProperty> selector)
Parameters
Type Name Description
Func<DateNanosPropertyDescriptor<T>, IDateNanosProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

DateRange(Func<DateRangePropertyDescriptor<T>, IDateRangeProperty>)

A range of date values represented as unsigned 64-bit integer milliseconds elapsed since system epoch.

Declaration
TReturnType DateRange(Func<DateRangePropertyDescriptor<T>, IDateRangeProperty> selector)
Parameters
Type Name Description
Func<DateRangePropertyDescriptor<T>, IDateRangeProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

DoubleRange(Func<DoubleRangePropertyDescriptor<T>, IDoubleRangeProperty>)

A range of double-precision 64-bit IEEE 754 floating point values.

Declaration
TReturnType DoubleRange(Func<DoubleRangePropertyDescriptor<T>, IDoubleRangeProperty> selector)
Parameters
Type Name Description
Func<DoubleRangePropertyDescriptor<T>, IDoubleRangeProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

FieldAlias(Func<FieldAliasPropertyDescriptor<T>, IFieldAliasProperty>)

An alias mapping defines an alternate name for a field in the index. The alias can be used in place of the target field in search requests, and selected other APIs like field capabilities.

Declaration
TReturnType FieldAlias(Func<FieldAliasPropertyDescriptor<T>, IFieldAliasProperty> selector)
Parameters
Type Name Description
Func<FieldAliasPropertyDescriptor<T>, IFieldAliasProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

FloatRange(Func<FloatRangePropertyDescriptor<T>, IFloatRangeProperty>)

A range of single-precision 32-bit IEEE 754 floating point values.

Declaration
TReturnType FloatRange(Func<FloatRangePropertyDescriptor<T>, IFloatRangeProperty> selector)
Parameters
Type Name Description
Func<FloatRangePropertyDescriptor<T>, IFloatRangeProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

GeoPoint(Func<GeoPointPropertyDescriptor<T>, IGeoPointProperty>)

Data type mapping to map a property as a geopoint

Declaration
TReturnType GeoPoint(Func<GeoPointPropertyDescriptor<T>, IGeoPointProperty> selector)
Parameters
Type Name Description
Func<GeoPointPropertyDescriptor<T>, IGeoPointProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

GeoShape(Func<GeoShapePropertyDescriptor<T>, IGeoShapeProperty>)

Maps a property as a geo_shape field

Declaration
TReturnType GeoShape(Func<GeoShapePropertyDescriptor<T>, IGeoShapeProperty> selector)
Parameters
Type Name Description
Func<GeoShapePropertyDescriptor<T>, IGeoShapeProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

IntegerRange(Func<IntegerRangePropertyDescriptor<T>, IIntegerRangeProperty>)

A range of signed 32-bit integers with a minimum value of -231 and maximum of 231-1.

Declaration
TReturnType IntegerRange(Func<IntegerRangePropertyDescriptor<T>, IIntegerRangeProperty> selector)
Parameters
Type Name Description
Func<IntegerRangePropertyDescriptor<T>, IIntegerRangeProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Ip(Func<IpPropertyDescriptor<T>, IIpProperty>)

An ip field can index/store either IPv4 or IPv6 addresses.

Declaration
TReturnType Ip(Func<IpPropertyDescriptor<T>, IIpProperty> selector)
Parameters
Type Name Description
Func<IpPropertyDescriptor<T>, IIpProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

IpRange(Func<IpRangePropertyDescriptor<T>, IIpRangeProperty>)

A range of ip values supporting either IPv4 or IPv6 (or mixed) addresses.

Declaration
TReturnType IpRange(Func<IpRangePropertyDescriptor<T>, IIpRangeProperty> selector)
Parameters
Type Name Description
Func<IpRangePropertyDescriptor<T>, IIpRangeProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Join(Func<JoinPropertyDescriptor<T>, IJoinProperty>)

The join datatype is a special field that creates parent/child relation within documents of the same index.

Declaration
TReturnType Join(Func<JoinPropertyDescriptor<T>, IJoinProperty> selector)
Parameters
Type Name Description
Func<JoinPropertyDescriptor<T>, IJoinProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Keyword(Func<KeywordPropertyDescriptor<T>, IKeywordProperty>)

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.
Declaration
TReturnType Keyword(Func<KeywordPropertyDescriptor<T>, IKeywordProperty> selector)
Parameters
Type Name Description
Func<KeywordPropertyDescriptor<T>, IKeywordProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

KnnVector(Func<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty>)

Declaration
TReturnType KnnVector(Func<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty> selector)
Parameters
Type Name Description
Func<KnnVectorPropertyDescriptor<T>, IKnnVectorProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

LongRange(Func<LongRangePropertyDescriptor<T>, ILongRangeProperty>)

A range of signed 64-bit integers with a minimum value of -263 and maximum of 263-1.

Declaration
TReturnType LongRange(Func<LongRangePropertyDescriptor<T>, ILongRangeProperty> selector)
Parameters
Type Name Description
Func<LongRangePropertyDescriptor<T>, ILongRangeProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Murmur3Hash(Func<Murmur3HashPropertyDescriptor<T>, IMurmur3HashProperty>)

Declaration
TReturnType Murmur3Hash(Func<Murmur3HashPropertyDescriptor<T>, IMurmur3HashProperty> selector)
Parameters
Type Name Description
Func<Murmur3HashPropertyDescriptor<T>, IMurmur3HashProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Nested<TChild>(Func<NestedPropertyDescriptor<T, TChild>, INestedProperty>)

A specialised version of the IObjectProperty datatype that allows arrays of objects to be indexed in a way that they can be queried independently of each other, using nested queries and aggregations.

Declaration
TReturnType Nested<TChild>(Func<NestedPropertyDescriptor<T, TChild>, INestedProperty> selector) where TChild : class
Parameters
Type Name Description
Func<NestedPropertyDescriptor<T, TChild>, INestedProperty> selector
Returns
Type Description
TReturnType
Type Parameters
Name Description
TChild
| Edit this page View Source

Number(Func<NumberPropertyDescriptor<T>, INumberProperty>)

Number introduces a numeric mapping that defaults to float. Use .Type() to set the right type if needed or use Scalar instead of Number(Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Number(Func<NumberPropertyDescriptor<T>, INumberProperty> selector)
Parameters
Type Name Description
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Object<TChild>(Func<ObjectTypeDescriptor<T, TChild>, IObjectProperty>)

A mapping for an inner object

Declaration
TReturnType Object<TChild>(Func<ObjectTypeDescriptor<T, TChild>, IObjectProperty> selector) where TChild : class
Parameters
Type Name Description
Func<ObjectTypeDescriptor<T, TChild>, IObjectProperty> selector
Returns
Type Description
TReturnType
Type Parameters
Name Description
TChild
| Edit this page View Source

Percolator(Func<PercolatorPropertyDescriptor<T>, IPercolatorProperty>)

The percolator datatype is used to store a query, so that the IPercolateQuery can use it to match provided documents.

Declaration
TReturnType Percolator(Func<PercolatorPropertyDescriptor<T>, IPercolatorProperty> selector)
Parameters
Type Name Description
Func<PercolatorPropertyDescriptor<T>, IPercolatorProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

RankFeature(Func<RankFeaturePropertyDescriptor<T>, IRankFeatureProperty>)

A field that can index numbers so that they can later be used to boost documents in queries with a rank_feature query.

Declaration
TReturnType RankFeature(Func<RankFeaturePropertyDescriptor<T>, IRankFeatureProperty> selector)
Parameters
Type Name Description
Func<RankFeaturePropertyDescriptor<T>, IRankFeatureProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

RankFeatures(Func<RankFeaturesPropertyDescriptor<T>, IRankFeaturesProperty>)

A field that can index numeric feature vectors, so that they can later be used to boost documents in queries with a rank_feature query. It is analogous to the IRankFeatureProperty datatype, but is better suited when the list of features is sparse so that it wouldn't be reasonable to add one field to the mappings for each of them.

Declaration
TReturnType RankFeatures(Func<RankFeaturesPropertyDescriptor<T>, IRankFeaturesProperty> selector)
Parameters
Type Name Description
Func<RankFeaturesPropertyDescriptor<T>, IRankFeaturesProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, DateRange>>, Func<DateRangePropertyDescriptor<T>, IDateRangeProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, DateRange>> field, Func<DateRangePropertyDescriptor<T>, IDateRangeProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, DateRange>> field
Func<DateRangePropertyDescriptor<T>, IDateRangeProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, DoubleRange>>, Func<DoubleRangePropertyDescriptor<T>, IDoubleRangeProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, DoubleRange>> field, Func<DoubleRangePropertyDescriptor<T>, IDoubleRangeProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, DoubleRange>> field
Func<DoubleRangePropertyDescriptor<T>, IDoubleRangeProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, FloatRange>>, Func<FloatRangePropertyDescriptor<T>, IFloatRangeProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, FloatRange>> field, Func<FloatRangePropertyDescriptor<T>, IFloatRangeProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, FloatRange>> field
Func<FloatRangePropertyDescriptor<T>, IFloatRangeProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IntegerRange>>, Func<IntegerRangePropertyDescriptor<T>, IIntegerRangeProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IntegerRange>> field, Func<IntegerRangePropertyDescriptor<T>, IIntegerRangeProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IntegerRange>> field
Func<IntegerRangePropertyDescriptor<T>, IIntegerRangeProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IpAddressRange>>, Func<IpRangePropertyDescriptor<T>, IIpRangeProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IpAddressRange>> field, Func<IpRangePropertyDescriptor<T>, IIpRangeProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IpAddressRange>> field
Func<IpRangePropertyDescriptor<T>, IIpRangeProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, LongRange>>, Func<LongRangePropertyDescriptor<T>, ILongRangeProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, LongRange>> field, Func<LongRangePropertyDescriptor<T>, ILongRangeProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, LongRange>> field
Func<LongRangePropertyDescriptor<T>, ILongRangeProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, bool>>, Func<BooleanPropertyDescriptor<T>, IBooleanProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, bool>> field, Func<BooleanPropertyDescriptor<T>, IBooleanProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, bool>> field
Func<BooleanPropertyDescriptor<T>, IBooleanProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, byte>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, byte>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, byte>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, char>>, Func<KeywordPropertyDescriptor<T>, IKeywordProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, char>> field, Func<KeywordPropertyDescriptor<T>, IKeywordProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, char>> field
Func<KeywordPropertyDescriptor<T>, IKeywordProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<bool>>>, Func<BooleanPropertyDescriptor<T>, IBooleanProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<bool>>> field, Func<BooleanPropertyDescriptor<T>, IBooleanProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<bool>>> field
Func<BooleanPropertyDescriptor<T>, IBooleanProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<byte>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<byte>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<byte>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<char>>>, Func<KeywordPropertyDescriptor<T>, IKeywordProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<char>>> field, Func<KeywordPropertyDescriptor<T>, IKeywordProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<char>>> field
Func<KeywordPropertyDescriptor<T>, IKeywordProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<DateTimeOffset>>>, Func<DatePropertyDescriptor<T>, IDateProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<DateTimeOffset>>> field, Func<DatePropertyDescriptor<T>, IDateProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<DateTimeOffset>>> field
Func<DatePropertyDescriptor<T>, IDateProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<DateTime>>>, Func<DatePropertyDescriptor<T>, IDateProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<DateTime>>> field, Func<DatePropertyDescriptor<T>, IDateProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<DateTime>>> field
Func<DatePropertyDescriptor<T>, IDateProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<decimal>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<decimal>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<decimal>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<double>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<double>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<double>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<Guid>>>, Func<KeywordPropertyDescriptor<T>, IKeywordProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<Guid>>> field, Func<KeywordPropertyDescriptor<T>, IKeywordProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<Guid>>> field
Func<KeywordPropertyDescriptor<T>, IKeywordProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<short>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<short>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<short>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<int>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<int>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<int>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<long>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<long>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<long>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<bool?>>>, Func<BooleanPropertyDescriptor<T>, IBooleanProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<bool?>>> field, Func<BooleanPropertyDescriptor<T>, IBooleanProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<bool?>>> field
Func<BooleanPropertyDescriptor<T>, IBooleanProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<byte?>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<byte?>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<byte?>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<char?>>>, Func<KeywordPropertyDescriptor<T>, IKeywordProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<char?>>> field, Func<KeywordPropertyDescriptor<T>, IKeywordProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<char?>>> field
Func<KeywordPropertyDescriptor<T>, IKeywordProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<DateTimeOffset?>>>, Func<DatePropertyDescriptor<T>, IDateProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<DateTimeOffset?>>> field, Func<DatePropertyDescriptor<T>, IDateProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<DateTimeOffset?>>> field
Func<DatePropertyDescriptor<T>, IDateProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<DateTime?>>>, Func<DatePropertyDescriptor<T>, IDateProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<DateTime?>>> field, Func<DatePropertyDescriptor<T>, IDateProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<DateTime?>>> field
Func<DatePropertyDescriptor<T>, IDateProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<decimal?>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<decimal?>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<decimal?>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<double?>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<double?>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<double?>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<Guid?>>>, Func<KeywordPropertyDescriptor<T>, IKeywordProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<Guid?>>> field, Func<KeywordPropertyDescriptor<T>, IKeywordProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<Guid?>>> field
Func<KeywordPropertyDescriptor<T>, IKeywordProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<short?>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<short?>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<short?>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<int?>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<int?>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<int?>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<long?>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<long?>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<long?>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<sbyte?>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<sbyte?>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<sbyte?>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<float?>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<float?>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<float?>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<TimeSpan?>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<TimeSpan?>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<TimeSpan?>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<uint?>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<uint?>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<uint?>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<ulong?>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<ulong?>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<ulong?>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<sbyte>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<sbyte>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<sbyte>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<float>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<float>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<float>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<string>>>, Func<TextPropertyDescriptor<T>, ITextProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<string>>> field, Func<TextPropertyDescriptor<T>, ITextProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<string>>> field
Func<TextPropertyDescriptor<T>, ITextProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<TimeSpan>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<TimeSpan>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<TimeSpan>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<uint>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<uint>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<uint>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, IEnumerable<ulong>>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, IEnumerable<ulong>>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, IEnumerable<ulong>>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, DateTimeOffset>>, Func<DatePropertyDescriptor<T>, IDateProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, DateTimeOffset>> field, Func<DatePropertyDescriptor<T>, IDateProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, DateTimeOffset>> field
Func<DatePropertyDescriptor<T>, IDateProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, DateTime>>, Func<DatePropertyDescriptor<T>, IDateProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, DateTime>> field, Func<DatePropertyDescriptor<T>, IDateProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, DateTime>> field
Func<DatePropertyDescriptor<T>, IDateProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, decimal>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, decimal>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, decimal>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, double>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, double>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, double>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, Enum>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, Enum>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, Enum>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, Guid>>, Func<KeywordPropertyDescriptor<T>, IKeywordProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, Guid>> field, Func<KeywordPropertyDescriptor<T>, IKeywordProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, Guid>> field
Func<KeywordPropertyDescriptor<T>, IKeywordProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, short>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, short>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, short>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, int>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, int>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, int>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, long>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, long>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, long>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, bool?>>, Func<BooleanPropertyDescriptor<T>, IBooleanProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, bool?>> field, Func<BooleanPropertyDescriptor<T>, IBooleanProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, bool?>> field
Func<BooleanPropertyDescriptor<T>, IBooleanProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, byte?>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, byte?>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, byte?>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, char?>>, Func<KeywordPropertyDescriptor<T>, IKeywordProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, char?>> field, Func<KeywordPropertyDescriptor<T>, IKeywordProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, char?>> field
Func<KeywordPropertyDescriptor<T>, IKeywordProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, DateTimeOffset?>>, Func<DatePropertyDescriptor<T>, IDateProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, DateTimeOffset?>> field, Func<DatePropertyDescriptor<T>, IDateProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, DateTimeOffset?>> field
Func<DatePropertyDescriptor<T>, IDateProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, DateTime?>>, Func<DatePropertyDescriptor<T>, IDateProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, DateTime?>> field, Func<DatePropertyDescriptor<T>, IDateProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, DateTime?>> field
Func<DatePropertyDescriptor<T>, IDateProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, decimal?>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, decimal?>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, decimal?>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, double?>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, double?>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, double?>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, Guid?>>, Func<KeywordPropertyDescriptor<T>, IKeywordProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, Guid?>> field, Func<KeywordPropertyDescriptor<T>, IKeywordProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, Guid?>> field
Func<KeywordPropertyDescriptor<T>, IKeywordProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, short?>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, short?>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, short?>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, int?>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, int?>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, int?>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, long?>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, long?>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, long?>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, sbyte?>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, sbyte?>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, sbyte?>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, float?>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, float?>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, float?>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, TimeSpan?>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, TimeSpan?>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, TimeSpan?>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, uint?>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, uint?>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, uint?>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, ulong?>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, ulong?>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, ulong?>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, sbyte>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, sbyte>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, sbyte>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, float>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, float>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, float>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, string>>, Func<TextPropertyDescriptor<T>, ITextProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, string>> field, Func<TextPropertyDescriptor<T>, ITextProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, string>> field
Func<TextPropertyDescriptor<T>, ITextProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, TimeSpan>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, TimeSpan>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, TimeSpan>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, uint>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, uint>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, uint>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Scalar(Expression<Func<T, ulong>>, Func<NumberPropertyDescriptor<T>, INumberProperty>)

Declaration
TReturnType Scalar(Expression<Func<T, ulong>> field, Func<NumberPropertyDescriptor<T>, INumberProperty> selector = null)
Parameters
Type Name Description
Expression<Func<T, ulong>> field
Func<NumberPropertyDescriptor<T>, INumberProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

SearchAsYouType(Func<SearchAsYouTypePropertyDescriptor<T>, ISearchAsYouTypeProperty>)

A text-like field that is optimized to provide out-of-the-box support for the "search as you type" completion use case.

It creates a series of subfields that are analyzed to index terms that can be efficiently matched by a query that partially matches the entire indexed text value. Both prefix completion (i.e matching terms starting at the beginning of the input) and infix completion (i.e. matching terms at any position within the input) are supported.
Declaration
TReturnType SearchAsYouType(Func<SearchAsYouTypePropertyDescriptor<T>, ISearchAsYouTypeProperty> selector)
Parameters
Type Name Description
Func<SearchAsYouTypePropertyDescriptor<T>, ISearchAsYouTypeProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

Text(Func<TextPropertyDescriptor<T>, ITextProperty>)

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
Declaration
TReturnType Text(Func<TextPropertyDescriptor<T>, ITextProperty> selector)
Parameters
Type Name Description
Func<TextPropertyDescriptor<T>, ITextProperty> selector
Returns
Type Description
TReturnType
| Edit this page View Source

TokenCount(Func<TokenCountPropertyDescriptor<T>, ITokenCountProperty>)

A field of type token_count is really an integer field which accepts string values, analyzes them, then indexes the number of tokens in the string.

Declaration
TReturnType TokenCount(Func<TokenCountPropertyDescriptor<T>, ITokenCountProperty> selector)
Parameters
Type Name Description
Func<TokenCountPropertyDescriptor<T>, ITokenCountProperty> selector
Returns
Type Description
TReturnType

Extension Methods