Search Results for

    Show / Hide Table of Contents

    Interface IDateIndexNameProcessor

    The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support.

    Inherited Members
    IProcessor.Name
    IProcessor.Description
    IProcessor.OnFailure
    IProcessor.If
    IProcessor.Tag
    IProcessor.IgnoreFailure
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public interface IDateIndexNameProcessor : IProcessor

    Properties

    | Edit this page View Source

    DateFormats

    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
    [DataMember(Name = "date_formats")]
    IEnumerable<string> DateFormats { get; set; }
    Property Value
    Type Description
    IEnumerable<string>
    | Edit this page View Source

    DateRounding

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

    Declaration
    [DataMember(Name = "date_rounding")]
    DateRounding? DateRounding { get; set; }
    Property Value
    Type Description
    DateRounding?
    | Edit this page View Source

    Field

    The field to get the date or timestamp from.

    Declaration
    [DataMember(Name = "field")]
    Field Field { get; set; }
    Property Value
    Type Description
    Field
    | Edit this page View Source

    IndexNameFormat

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

    Declaration
    [DataMember(Name = "index_name_format")]
    string IndexNameFormat { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    IndexNamePrefix

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

    Declaration
    [DataMember(Name = "index_name_prefix")]
    string IndexNamePrefix { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    Locale

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

    Declaration
    [DataMember(Name = "locale")]
    string Locale { get; set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    TimeZone

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

    Declaration
    [DataMember(Name = "timezone")]
    string TimeZone { get; set; }
    Property Value
    Type Description
    string

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • DateFormats
      • DateRounding
      • Field
      • IndexNameFormat
      • IndexNamePrefix
      • Locale
      • TimeZone
    • Extension Methods
    Back to top Generated by DocFX