Class DateIndexNameProcessor.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch.ingest.ProcessorBase.AbstractBuilder<DateIndexNameProcessor.Builder>
org.opensearch.client.opensearch.ingest.DateIndexNameProcessor.Builder
- All Implemented Interfaces:
CopyableBuilder<DateIndexNameProcessor.Builder,,DateIndexNameProcessor> MutableBuilder<DateIndexNameProcessor.Builder,,DateIndexNameProcessor> ObjectBuilder<DateIndexNameProcessor>
- Enclosing class:
DateIndexNameProcessor
public static class DateIndexNameProcessor.Builder
extends ProcessorBase.AbstractBuilder<DateIndexNameProcessor.Builder>
implements CopyableBuilder<DateIndexNameProcessor.Builder,DateIndexNameProcessor>
Builder for
DateIndexNameProcessor.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aDateIndexNameProcessor.copy()Create a new builderCopyableBuilderthat is a copy of this one.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 - API name:fieldindexNameFormat(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.Builderself()The time zone to use when parsing the date and when date math index supports resolves expressions into concrete index names.Methods inherited from class org.opensearch.client.opensearch.ingest.ProcessorBase.AbstractBuilder
description, if_, ignoreFailure, onFailure, onFailure, onFailure, tagMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<DateIndexNameProcessor.Builder,DateIndexNameProcessor> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classProcessorBase.AbstractBuilder<DateIndexNameProcessor.Builder>
-
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, orTAI64N.API name:
date_formatsAdds all elements of
listtodateFormats. -
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, orTAI64N.API name:
date_formatsAdds 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 - 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 time zone to use when parsing the date and when date math index supports resolves expressions into concrete index names.API name:
timezone -
build
Builds aDateIndexNameProcessor.- Specified by:
buildin interfaceObjectBuilder<DateIndexNameProcessor>- Throws:
NullPointerException- if some of the required fields are null.
-