Class DateIndexNameProcessorDescriptor<T>

Inheritance
object
DescriptorBase<DateIndexNameProcessorDescriptor<T>, IDateIndexNameProcessor>
ProcessorDescriptorBase<DateIndexNameProcessorDescriptor<T>, IDateIndexNameProcessor>
DateIndexNameProcessorDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class DateIndexNameProcessorDescriptor<T> : ProcessorDescriptorBase<DateIndexNameProcessorDescriptor<T>, IDateIndexNameProcessor>, IDescriptor, IDateIndexNameProcessor, IProcessor where T : class
Type Parameters
Name Description
T

Properties

| Edit this page View Source

Name

Declaration
protected override string Name { get; }
Property Value
Type Description
string
Overrides

Methods

| Edit this page View Source

DateFormats(IEnumerable<string>)

An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. Default is yyyy-MM-dd'T'HH:mm:ss.SSSZ

Declaration
public DateIndexNameProcessorDescriptor<T> DateFormats(IEnumerable<string> dateFormats)
Parameters
Type Name Description
IEnumerable<string> dateFormats
Returns
Type Description
DateIndexNameProcessorDescriptor<T>
| Edit this page View Source

DateFormats(params string[])

An array of the expected date formats for parsing dates / timestamps in the document being preprocessed. Default is yyyy-MM-dd'T'HH:mm:ss.SSSZ

Declaration
public DateIndexNameProcessorDescriptor<T> DateFormats(params string[] dateFormats)
Parameters
Type Name Description
string[] dateFormats
Returns
Type Description
DateIndexNameProcessorDescriptor<T>
| Edit this page View Source

DateRounding(DateRounding?)

How to round the date when formatting the date into the index name.

Declaration
public DateIndexNameProcessorDescriptor<T> DateRounding(DateRounding? dateRounding)
Parameters
Type Name Description
DateRounding? dateRounding
Returns
Type Description
DateIndexNameProcessorDescriptor<T>
| Edit this page View Source

Field(Field)

The field to get the date or timestamp from.

Declaration
public DateIndexNameProcessorDescriptor<T> Field(Field field)
Parameters
Type Name Description
Field field
Returns
Type Description
DateIndexNameProcessorDescriptor<T>
| Edit this page View Source

Field<TValue>(Expression<Func<T, TValue>>)

The field to get the date or timestamp from.

Declaration
public DateIndexNameProcessorDescriptor<T> Field<TValue>(Expression<Func<T, TValue>> objectPath)
Parameters
Type Name Description
Expression<Func<T, TValue>> objectPath
Returns
Type Description
DateIndexNameProcessorDescriptor<T>
Type Parameters
Name Description
TValue
| Edit this page View Source

IndexNameFormat(string)

The format to be used when printing the parsed date into the index name.

Declaration
public DateIndexNameProcessorDescriptor<T> IndexNameFormat(string indexNameFormat)
Parameters
Type Name Description
string indexNameFormat
Returns
Type Description
DateIndexNameProcessorDescriptor<T>
| Edit this page View Source

IndexNamePrefix(string)

A prefix of the index name to be prepended before the printed date.

Declaration
public DateIndexNameProcessorDescriptor<T> IndexNamePrefix(string indexNamePrefix)
Parameters
Type Name Description
string indexNamePrefix
Returns
Type Description
DateIndexNameProcessorDescriptor<T>
| Edit this page View Source

Locale(string)

The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days.

Declaration
public DateIndexNameProcessorDescriptor<T> Locale(string locale)
Parameters
Type Name Description
string locale
Returns
Type Description
DateIndexNameProcessorDescriptor<T>
| Edit this page View Source

TimeZone(string)

The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names.

Declaration
public DateIndexNameProcessorDescriptor<T> TimeZone(string timeZone)
Parameters
Type Name Description
string timeZone
Returns
Type Description
DateIndexNameProcessorDescriptor<T>

Implements

Extension Methods