Package co.elastic.clients.elasticsearch.ingest

Class DateProcessor.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch.ingest.ProcessorBase.AbstractBuilder<DateProcessor.Builder>

co.elastic.clients.elasticsearch.ingest.DateProcessor.Builder

All Implemented Interfaces:

WithJson<DateProcessor.Builder>, ObjectBuilder<DateProcessor>

Enclosing class:

DateProcessor

public static class DateProcessor.Builder
extends ProcessorBase.AbstractBuilder<DateProcessor.Builder>
implements ObjectBuilder<DateProcessor>

Builder for DateProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DateProcessor	build()	Builds a DateProcessor.
final DateProcessor.Builder	field(String value)	Required - The field to get the date from.
final DateProcessor.Builder	formats(String value, String... values)	Required - An array of the expected date formats.
final DateProcessor.Builder	formats(List<String> list)	Required - An array of the expected date formats.
final DateProcessor.Builder	locale(String value)	The locale to use when parsing the date, relevant when parsing month names or week days.
final DateProcessor.Builder	outputFormat(String value)	The format to use when writing the date to target_field.
protected DateProcessor.Builder	self()
final DateProcessor.Builder	targetField(String value)	The field that will hold the parsed date.
final DateProcessor.Builder	timezone(String value)	The timezone to use when parsing the date.

Methods inherited from class co.elastic.clients.elasticsearch.ingest.ProcessorBase.AbstractBuilder

description, if_, if_, ignoreFailure, onFailure, 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

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

field

public final DateProcessor.Builder field(String value)

Required - The field to get the date from.

API name: field

formats

public final DateProcessor.Builder formats(List<String> list)

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

Adds all elements of list to formats.

formats

public final DateProcessor.Builder formats(String value,
 String... values)

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

Adds one or more values to formats.

locale

public final DateProcessor.Builder locale(@Nullable
 String value)

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

API name: locale

targetField

public final DateProcessor.Builder targetField(@Nullable
 String value)

The field that will hold the parsed date.

API name: target_field

timezone

public final DateProcessor.Builder timezone(@Nullable
 String value)

The timezone to use when parsing the date. Supports template snippets.

API name: timezone

outputFormat

public final DateProcessor.Builder outputFormat(@Nullable
 String value)

The format to use when writing the date to target_field. Must be a valid java time pattern.

API name: output_format

self

protected DateProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<DateProcessor.Builder>

build

public DateProcessor build()

Builds a DateProcessor.

Specified by:

build in interface ObjectBuilder<DateProcessor>

Throws:

NullPointerException - if some of the required fields are null.