Class DateProcessorDescriptor<T>

Inheritance
object
DescriptorBase<DateProcessorDescriptor<T>, IDateProcessor>
ProcessorDescriptorBase<DateProcessorDescriptor<T>, IDateProcessor>
DateProcessorDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class DateProcessorDescriptor<T> : ProcessorDescriptorBase<DateProcessorDescriptor<T>, IDateProcessor>, IDescriptor, IDateProcessor, 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

Field(Field)

The field to get the date from.

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

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

The field to get the date from.

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

Formats(IEnumerable<string>)

An array of the expected date formats. Can be a Joda pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.

Declaration
public DateProcessorDescriptor<T> Formats(IEnumerable<string> matchFormats)
Parameters
Type Name Description
IEnumerable<string> matchFormats
Returns
Type Description
DateProcessorDescriptor<T>
| Edit this page View Source

Formats(params string[])

An array of the expected date formats. Can be a Joda pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.

Declaration
public DateProcessorDescriptor<T> Formats(params string[] matchFormats)
Parameters
Type Name Description
string[] matchFormats
Returns
Type Description
DateProcessorDescriptor<T>
| Edit this page View Source

Locale(string)

The locale to use when parsing the date, relevant when parsing month names or week days. Supports template snippets.

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

TargetField(Field)

The field that will hold the parsed date. Defaults to @timestamp

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

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

The field that will hold the parsed date. Defaults to @timestamp

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

TimeZone(string)

The timezone to use when parsing the date. Supports template snippets.

Declaration
public DateProcessorDescriptor<T> TimeZone(string timezone)
Parameters
Type Name Description
string timezone
Returns
Type Description
DateProcessorDescriptor<T>

Implements

Extension Methods