Package org.opensearch.client.opensearch.ingest

Class DateProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ingest.ProcessorBase.AbstractBuilder<DateProcessor.Builder>

org.opensearch.client.opensearch.ingest.DateProcessor.Builder

All Implemented Interfaces:

CopyableBuilder<DateProcessor.Builder,DateProcessor>, MutableBuilder<DateProcessor.Builder,DateProcessor>, ObjectBuilder<DateProcessor>

Enclosing class:

DateProcessor

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

Builder for DateProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DateProcessor	build()	Builds a DateProcessor.
DateProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DateProcessor.Builder	field(String value)	Required - API name: field
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.
protected DateProcessor.Builder	self()
final DateProcessor.Builder	targetField(String value)	API name: target_field
final DateProcessor.Builder	timezone(String value)	The time zone to use when parsing the date.

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

description, if_, ignoreFailure, onFailure, onFailure, onFailure, tag

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

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.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public DateProcessor.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<DateProcessor.Builder,DateProcessor>

Returns:

a new builder instance.

self

@Nonnull
protected DateProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<DateProcessor.Builder>

field

@Nonnull
public final DateProcessor.Builder field(String value)

Required - API name: field

formats

@Nonnull
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

@Nonnull
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

@Nonnull
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

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

API name: target_field

timezone

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

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

API name: timezone

build

@Nonnull
public DateProcessor build()

Builds a DateProcessor.

Specified by:

build in interface ObjectBuilder<DateProcessor>

Throws:

NullPointerException - if some of the required fields are null.