Package org.opensearch.client.opensearch.ingest

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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DateIndexNameProcessor	build()	Builds a DateIndexNameProcessor.
DateIndexNameProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final DateIndexNameProcessor.Builder	dateFormats(String value, String... values)	Required - An array of the expected date formats for parsing dates/timestamps in the document being preprocessed.
final DateIndexNameProcessor.Builder	dateFormats(List<String> list)	Required - An array of the expected date formats for parsing dates/timestamps in the document being preprocessed.
final DateIndexNameProcessor.Builder	dateRounding(String value)	Required - How to round the date when formatting the date into the index name.
final DateIndexNameProcessor.Builder	field(String value)	Required - API name: field
final DateIndexNameProcessor.Builder	indexNameFormat(String value)	The format to be used when printing the parsed date into the index name.
final DateIndexNameProcessor.Builder	indexNamePrefix(String value)	A prefix of the index name to be prepended before the printed date.
final DateIndexNameProcessor.Builder	locale(String value)	The locale to use when parsing the date from the document being preprocessed, relevant when parsing month names or week days.
protected DateIndexNameProcessor.Builder	self()
final DateIndexNameProcessor.Builder	timezone(String value)	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, 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 DateIndexNameProcessor.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<DateIndexNameProcessor.Builder,DateIndexNameProcessor>

Returns:

a new builder instance.

self

@Nonnull
protected DateIndexNameProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<DateIndexNameProcessor.Builder>

dateFormats

@Nonnull
public final DateIndexNameProcessor.Builder dateFormats(List<String> list)

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, or TAI64N.

API name: date_formats

Adds all elements of list to dateFormats.

dateFormats

@Nonnull
public final DateIndexNameProcessor.Builder dateFormats(String value,
 String... values)

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, or TAI64N.

API name: date_formats

Adds one or more values to dateFormats.

dateRounding

@Nonnull
public final DateIndexNameProcessor.Builder dateRounding(String value)

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

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

Required - API name: field

indexNameFormat

@Nonnull
public final DateIndexNameProcessor.Builder indexNameFormat(@Nullable
 String value)

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

@Nonnull
public final DateIndexNameProcessor.Builder indexNamePrefix(@Nullable
 String value)

A prefix of the index name to be prepended before the printed date. Supports template snippets.

API name: index_name_prefix

locale

@Nonnull
public final DateIndexNameProcessor.Builder locale(@Nullable
 String value)

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

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

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

@Nonnull
public DateIndexNameProcessor build()

Builds a DateIndexNameProcessor.

Specified by:

build in interface ObjectBuilder<DateIndexNameProcessor>

Throws:

NullPointerException - if some of the required fields are null.