Class DateIndexNameProcessor.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch.ingest.ProcessorBase.AbstractBuilder<DateIndexNameProcessor.Builder>
co.elastic.clients.elasticsearch.ingest.DateIndexNameProcessor.Builder
- All Implemented Interfaces:
WithJson<DateIndexNameProcessor.Builder>
,ObjectBuilder<DateIndexNameProcessor>
- Enclosing class:
- DateIndexNameProcessor
public static class DateIndexNameProcessor.Builder
extends ProcessorBase.AbstractBuilder<DateIndexNameProcessor.Builder>
implements ObjectBuilder<DateIndexNameProcessor>
Builder for
DateIndexNameProcessor
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aDateIndexNameProcessor
.dateFormats
(String value, String... values) Required - An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.dateFormats
(List<String> list) Required - An array of the expected date formats for parsing dates / timestamps in the document being preprocessed.dateRounding
(String value) Required - How to round the date when formatting the date into the index name.Required - The field to get the date or timestamp from.indexNameFormat
(String value) The format to be used when printing the parsed date into the index name.indexNamePrefix
(String value) A prefix of the index name to be prepended before the printed date.The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days.protected DateIndexNameProcessor.Builder
self()
The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names.Methods inherited from class co.elastic.clients.elasticsearch.ingest.ProcessorBase.AbstractBuilder
description, if_, ignoreFailure, onFailure, onFailure, onFailure, tag
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
Adds all elements of
list
todateFormats
. -
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
Adds one or more values to
dateFormats
. -
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) ands
(second). Supports template snippets.API name:
date_rounding
-
field
Required - The field to get the date or timestamp from.API name:
field
-
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
A prefix of the index name to be prepended before the printed date. Supports template snippets.API name:
index_name_prefix
-
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
The timezone to use when parsing the date and when date math index supports resolves expressions into concrete index names.API name:
timezone
-
self
- Specified by:
self
in classProcessorBase.AbstractBuilder<DateIndexNameProcessor.Builder>
-
build
Builds aDateIndexNameProcessor
.- Specified by:
build
in interfaceObjectBuilder<DateIndexNameProcessor>
- Throws:
NullPointerException
- if some of the required fields are null.
-