Package org.opensearch.client.opensearch.ingest

Class DateIndexNameProcessor

java.lang.Object
org.opensearch.client.opensearch.ingest.ProcessorBase
org.opensearch.client.opensearch.ingest.DateIndexNameProcessor
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ProcessorVariant, ToCopyableBuilder<DateIndexNameProcessor.Builder,DateIndexNameProcessor>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class DateIndexNameProcessor extends ProcessorBase implements ProcessorVariant, ToCopyableBuilder<DateIndexNameProcessor.Builder,DateIndexNameProcessor>

  • Field Details

  • Method Details

    • of

      public static DateIndexNameProcessor of(Function<DateIndexNameProcessor.Builder,ObjectBuilder<DateIndexNameProcessor>> fn)

    • _processorKind

      public Processor.Kind _processorKind()
      Processor variant kind.
      Specified by:
      _processorKind in interface ProcessorVariant

    • dateFormats

      @Nonnull public final List<String> dateFormats()
      Required - An array of the expected date formats for parsing dates/timestamps in the document being preprocessed. Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.

      API name: date_formats

    • dateRounding

      @Nonnull public final String dateRounding()
      Required - How to round the date when formatting the date into the index name. Valid values are: y (year), M (month), w (week), d (day), h (hour), m (minute) and s (second). Supports template snippets.

      API name: date_rounding

    • field

      @Nonnull public final String field()
      Required - API name: field

    • indexNameFormat

      @Nullable public final String indexNameFormat()
      The format to be used when printing the parsed date into the index name. A valid java time pattern is expected here. Supports template snippets.

      API name: index_name_format

    • indexNamePrefix

      @Nullable public final String indexNamePrefix()
      A prefix of the index name to be prepended before the printed date. Supports template snippets.

      API name: index_name_prefix

    • locale

      @Nullable public final String locale()
      The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days.

      API name: locale

    • timezone

      @Nullable public final String timezone()
      The time zone to use when parsing the date and when date math index supports resolves expressions into concrete index names.

      API name: timezone

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Overrides:
      serializeInternal in class ProcessorBase

    • toBuilder

      @Nonnull public DateIndexNameProcessor.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DateIndexNameProcessor.Builder,DateIndexNameProcessor>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static DateIndexNameProcessor.Builder builder()

    • setupDateIndexNameProcessorDeserializer

      protected static void setupDateIndexNameProcessorDeserializer(ObjectDeserializer<DateIndexNameProcessor.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class ProcessorBase

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class ProcessorBase