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, ProcessorVariant

@JsonpDeserializable
public class DateIndexNameProcessor
extends ProcessorBase
implements ProcessorVariant

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DateIndexNameProcessor.Builder	Builder for DateIndexNameProcessor.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.ingest.ProcessorBase

ProcessorBase.AbstractBuilder<BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<DateIndexNameProcessor>	_DESERIALIZER	Json deserializer for DateIndexNameProcessor

Method Summary

Modifier and Type	Method	Description
Processor.Kind	_processorKind()	Processor variant kind.
java.util.List<java.lang.String>	dateFormats()	Required - API name: date_formats
java.lang.String	dateRounding()	Required - How to round the date when formatting the date into the index name.
java.lang.String	field()	Required - API name: field
java.lang.String	indexNameFormat()	Required - API name: index_name_format
java.lang.String	indexNamePrefix()	Required - API name: index_name_prefix
java.lang.String	locale()	Required - API name: locale
static DateIndexNameProcessor	of(java.util.function.Function<DateIndexNameProcessor.Builder,ObjectBuilder<DateIndexNameProcessor>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupDateIndexNameProcessorDeserializer(ObjectDeserializer<DateIndexNameProcessor.Builder> op)
java.lang.String	timezone()	Required - API name: timezone

Methods inherited from class org.opensearch.client.opensearch.ingest.ProcessorBase

if_, ignoreFailure, onFailure, serialize, setupProcessorBaseDeserializer, tag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.opensearch.ingest.ProcessorVariant

_toProcessor

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<DateIndexNameProcessor> _DESERIALIZER

Json deserializer for DateIndexNameProcessor

Method Detail

of

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

_processorKind

public Processor.Kind _processorKind()

Processor variant kind.

Specified by:

_processorKind in interface ProcessorVariant

dateFormats

public final java.util.List<java.lang.String> dateFormats()

Required - API name: date_formats

dateRounding

public final java.lang.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

public final java.lang.String field()

Required - API name: field

indexNameFormat

public final java.lang.String indexNameFormat()

Required - API name: index_name_format

indexNamePrefix

public final java.lang.String indexNamePrefix()

Required - API name: index_name_prefix

locale

public final java.lang.String locale()

Required - API name: locale

timezone

public final java.lang.String timezone()

Required - API name: timezone

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

Overrides:

serializeInternal in class ProcessorBase

setupDateIndexNameProcessorDeserializer

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