co.elastic.clients.elasticsearch.ingest.DateIndexNameProcessor Maven / Gradle / Ivy
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package co.elastic.clients.elasticsearch.ingest;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import jakarta.json.stream.JsonGenerator;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: ingest._types.DateIndexNameProcessor
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class DateIndexNameProcessor extends ProcessorBase implements ProcessorVariant {
private final List dateFormats;
private final String dateRounding;
private final String field;
@Nullable
private final String indexNameFormat;
@Nullable
private final String indexNamePrefix;
@Nullable
private final String locale;
@Nullable
private final String timezone;
// ---------------------------------------------------------------------------------------------
private DateIndexNameProcessor(Builder builder) {
super(builder);
this.dateFormats = ApiTypeHelper.unmodifiableRequired(builder.dateFormats, this, "dateFormats");
this.dateRounding = ApiTypeHelper.requireNonNull(builder.dateRounding, this, "dateRounding");
this.field = ApiTypeHelper.requireNonNull(builder.field, this, "field");
this.indexNameFormat = builder.indexNameFormat;
this.indexNamePrefix = builder.indexNamePrefix;
this.locale = builder.locale;
this.timezone = builder.timezone;
}
public static DateIndexNameProcessor of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Processor variant kind.
*/
@Override
public Processor.Kind _processorKind() {
return Processor.Kind.DateIndexName;
}
/**
* 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: {@code date_formats}
*/
public final List dateFormats() {
return this.dateFormats;
}
/**
* 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: {@code date_rounding}
*/
public final String dateRounding() {
return this.dateRounding;
}
/**
* Required - The field to get the date or timestamp from.
*
* API name: {@code field}
*/
public final String field() {
return this.field;
}
/**
* 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: {@code index_name_format}
*/
@Nullable
public final String indexNameFormat() {
return this.indexNameFormat;
}
/**
* A prefix of the index name to be prepended before the printed date. Supports
* template snippets.
*
* API name: {@code index_name_prefix}
*/
@Nullable
public final String indexNamePrefix() {
return this.indexNamePrefix;
}
/**
* The locale to use when parsing the date from the document being preprocessed,
* relevant when parsing month names or week days.
*
* API name: {@code locale}
*/
@Nullable
public final String locale() {
return this.locale;
}
/**
* The timezone to use when parsing the date and when date math index supports
* resolves expressions into concrete index names.
*
* API name: {@code timezone}
*/
@Nullable
public final String timezone() {
return this.timezone;
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
super.serializeInternal(generator, mapper);
if (ApiTypeHelper.isDefined(this.dateFormats)) {
generator.writeKey("date_formats");
generator.writeStartArray();
for (String item0 : this.dateFormats) {
generator.write(item0);
}
generator.writeEnd();
}
generator.writeKey("date_rounding");
generator.write(this.dateRounding);
generator.writeKey("field");
generator.write(this.field);
if (this.indexNameFormat != null) {
generator.writeKey("index_name_format");
generator.write(this.indexNameFormat);
}
if (this.indexNamePrefix != null) {
generator.writeKey("index_name_prefix");
generator.write(this.indexNamePrefix);
}
if (this.locale != null) {
generator.writeKey("locale");
generator.write(this.locale);
}
if (this.timezone != null) {
generator.writeKey("timezone");
generator.write(this.timezone);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link DateIndexNameProcessor}.
*/
public static class Builder extends ProcessorBase.AbstractBuilder
implements
ObjectBuilder {
private List dateFormats;
private String dateRounding;
private String field;
@Nullable
private String indexNameFormat;
@Nullable
private String indexNamePrefix;
@Nullable
private String locale;
@Nullable
private String timezone;
/**
* 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: {@code date_formats}
*
* Adds all elements of list to dateFormats.
*/
public final Builder dateFormats(List list) {
this.dateFormats = _listAddAll(this.dateFormats, list);
return this;
}
/**
* 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: {@code date_formats}
*
* Adds one or more values to dateFormats.
*/
public final Builder dateFormats(String value, String... values) {
this.dateFormats = _listAdd(this.dateFormats, value, values);
return this;
}
/**
* 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: {@code date_rounding}
*/
public final Builder dateRounding(String value) {
this.dateRounding = value;
return this;
}
/**
* Required - The field to get the date or timestamp from.
*
* API name: {@code field}
*/
public final Builder field(String value) {
this.field = value;
return this;
}
/**
* 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: {@code index_name_format}
*/
public final Builder indexNameFormat(@Nullable String value) {
this.indexNameFormat = value;
return this;
}
/**
* A prefix of the index name to be prepended before the printed date. Supports
* template snippets.
*
* API name: {@code index_name_prefix}
*/
public final Builder indexNamePrefix(@Nullable String value) {
this.indexNamePrefix = value;
return this;
}
/**
* The locale to use when parsing the date from the document being preprocessed,
* relevant when parsing month names or week days.
*
* API name: {@code locale}
*/
public final Builder locale(@Nullable String value) {
this.locale = value;
return this;
}
/**
* The timezone to use when parsing the date and when date math index supports
* resolves expressions into concrete index names.
*
* API name: {@code timezone}
*/
public final Builder timezone(@Nullable String value) {
this.timezone = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link DateIndexNameProcessor}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public DateIndexNameProcessor build() {
_checkSingleUse();
return new DateIndexNameProcessor(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link DateIndexNameProcessor}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, DateIndexNameProcessor::setupDateIndexNameProcessorDeserializer);
protected static void setupDateIndexNameProcessorDeserializer(
ObjectDeserializer op) {
ProcessorBase.setupProcessorBaseDeserializer(op);
op.add(Builder::dateFormats, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()),
"date_formats");
op.add(Builder::dateRounding, JsonpDeserializer.stringDeserializer(), "date_rounding");
op.add(Builder::field, JsonpDeserializer.stringDeserializer(), "field");
op.add(Builder::indexNameFormat, JsonpDeserializer.stringDeserializer(), "index_name_format");
op.add(Builder::indexNamePrefix, JsonpDeserializer.stringDeserializer(), "index_name_prefix");
op.add(Builder::locale, JsonpDeserializer.stringDeserializer(), "locale");
op.add(Builder::timezone, JsonpDeserializer.stringDeserializer(), "timezone");
}
}