Package org.opensearch.client.opensearch.ingest

Class DateProcessor

java.lang.Object

org.opensearch.client.opensearch.ingest.ProcessorBase

org.opensearch.client.opensearch.ingest.DateProcessor

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ProcessorVariant, ToCopyableBuilder<DateProcessor.Builder,DateProcessor>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class DateProcessor
extends ProcessorBase
implements ProcessorVariant, ToCopyableBuilder<DateProcessor.Builder,DateProcessor>

Nested Class Summary

Nested Classes

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

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 final JsonpDeserializer<DateProcessor>	_DESERIALIZER	Json deserializer for DateProcessor

Method Summary

Modifier and Type	Method	Description
Processor.Kind	_processorKind()	Processor variant kind.
static DateProcessor.Builder	builder()
boolean	equals(Object o)
final String	field()	Required - API name: field
final List<String>	formats()	Required - An array of the expected date formats.
int	hashCode()
final String	locale()	The locale to use when parsing the date, relevant when parsing month names or week days.
static DateProcessor	of(Function<DateProcessor.Builder,ObjectBuilder<DateProcessor>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupDateProcessorDeserializer(ObjectDeserializer<DateProcessor.Builder> op)
final String	targetField()	API name: target_field
final String	timezone()	The time zone to use when parsing the date.
DateProcessor.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

description, if_, ignoreFailure, onFailure, serialize, setupProcessorBaseDeserializer, tag

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

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

toProcessor

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<DateProcessor> _DESERIALIZER

Json deserializer for DateProcessor

Method Details

of

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

_processorKind

public Processor.Kind _processorKind()

Processor variant kind.

Specified by:

_processorKind in interface ProcessorVariant

field

@Nonnull
public final String field()

Required - API name: field

formats

@Nonnull
public final List<String> formats()

Required - An array of the expected date formats. Can be a java time pattern or one of the following formats: ISO8601, UNIX, UNIX_MS, or TAI64N.

API name: formats

locale

@Nullable
public final String locale()

The locale to use when parsing the date, relevant when parsing month names or week days. Supports template snippets.

API name: locale

targetField

@Nullable
public final String targetField()

API name: target_field

timezone

@Nullable
public final String timezone()

The time zone to use when parsing the date. Supports template snippets.

API name: timezone

serializeInternal

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

Overrides:

serializeInternal in class ProcessorBase

toBuilder

@Nonnull
public DateProcessor.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<DateProcessor.Builder,DateProcessor>

Returns:

a new builder instance.

builder

@Nonnull
public static DateProcessor.Builder builder()

setupDateProcessorDeserializer

protected static void setupDateProcessorDeserializer(ObjectDeserializer<DateProcessor.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class ProcessorBase

equals

public boolean equals(Object o)

Overrides:

equals in class ProcessorBase