co.elastic.clients.elasticsearch.ingest.DateProcessor Maven / Gradle / Ivy
Show all versions of elasticsearch-java Show documentation
/*
* 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.DateProcessor
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class DateProcessor extends ProcessorBase implements ProcessorVariant {
private final String field;
private final List formats;
@Nullable
private final String locale;
@Nullable
private final String targetField;
@Nullable
private final String timezone;
@Nullable
private final String outputFormat;
// ---------------------------------------------------------------------------------------------
private DateProcessor(Builder builder) {
super(builder);
this.field = ApiTypeHelper.requireNonNull(builder.field, this, "field");
this.formats = ApiTypeHelper.unmodifiableRequired(builder.formats, this, "formats");
this.locale = builder.locale;
this.targetField = builder.targetField;
this.timezone = builder.timezone;
this.outputFormat = builder.outputFormat;
}
public static DateProcessor of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Processor variant kind.
*/
@Override
public Processor.Kind _processorKind() {
return Processor.Kind.Date;
}
/**
* Required - The field to get the date from.
*
* API name: {@code field}
*/
public final String field() {
return this.field;
}
/**
* 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: {@code formats}
*/
public final List formats() {
return this.formats;
}
/**
* The locale to use when parsing the date, relevant when parsing month names or
* week days. Supports template snippets.
*
* API name: {@code locale}
*/
@Nullable
public final String locale() {
return this.locale;
}
/**
* The field that will hold the parsed date.
*
* API name: {@code target_field}
*/
@Nullable
public final String targetField() {
return this.targetField;
}
/**
* The timezone to use when parsing the date. Supports template snippets.
*
* API name: {@code timezone}
*/
@Nullable
public final String timezone() {
return this.timezone;
}
/**
* The format to use when writing the date to target_field. Must be a valid java
* time pattern.
*
* API name: {@code output_format}
*/
@Nullable
public final String outputFormat() {
return this.outputFormat;
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
super.serializeInternal(generator, mapper);
generator.writeKey("field");
generator.write(this.field);
if (ApiTypeHelper.isDefined(this.formats)) {
generator.writeKey("formats");
generator.writeStartArray();
for (String item0 : this.formats) {
generator.write(item0);
}
generator.writeEnd();
}
if (this.locale != null) {
generator.writeKey("locale");
generator.write(this.locale);
}
if (this.targetField != null) {
generator.writeKey("target_field");
generator.write(this.targetField);
}
if (this.timezone != null) {
generator.writeKey("timezone");
generator.write(this.timezone);
}
if (this.outputFormat != null) {
generator.writeKey("output_format");
generator.write(this.outputFormat);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link DateProcessor}.
*/
public static class Builder extends ProcessorBase.AbstractBuilder implements ObjectBuilder {
private String field;
private List formats;
@Nullable
private String locale;
@Nullable
private String targetField;
@Nullable
private String timezone;
@Nullable
private String outputFormat;
/**
* Required - The field to get the date from.
*
* API name: {@code field}
*/
public final Builder field(String value) {
this.field = value;
return this;
}
/**
* 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: {@code formats}
*
* Adds all elements of list to formats.
*/
public final Builder formats(List list) {
this.formats = _listAddAll(this.formats, list);
return this;
}
/**
* 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: {@code formats}
*
* Adds one or more values to formats.
*/
public final Builder formats(String value, String... values) {
this.formats = _listAdd(this.formats, value, values);
return this;
}
/**
* The locale to use when parsing the date, relevant when parsing month names or
* week days. Supports template snippets.
*
* API name: {@code locale}
*/
public final Builder locale(@Nullable String value) {
this.locale = value;
return this;
}
/**
* The field that will hold the parsed date.
*
* API name: {@code target_field}
*/
public final Builder targetField(@Nullable String value) {
this.targetField = value;
return this;
}
/**
* The timezone to use when parsing the date. Supports template snippets.
*
* API name: {@code timezone}
*/
public final Builder timezone(@Nullable String value) {
this.timezone = value;
return this;
}
/**
* The format to use when writing the date to target_field. Must be a valid java
* time pattern.
*
* API name: {@code output_format}
*/
public final Builder outputFormat(@Nullable String value) {
this.outputFormat = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link DateProcessor}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public DateProcessor build() {
_checkSingleUse();
return new DateProcessor(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link DateProcessor}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
DateProcessor::setupDateProcessorDeserializer);
protected static void setupDateProcessorDeserializer(ObjectDeserializer op) {
ProcessorBase.setupProcessorBaseDeserializer(op);
op.add(Builder::field, JsonpDeserializer.stringDeserializer(), "field");
op.add(Builder::formats, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()),
"formats");
op.add(Builder::locale, JsonpDeserializer.stringDeserializer(), "locale");
op.add(Builder::targetField, JsonpDeserializer.stringDeserializer(), "target_field");
op.add(Builder::timezone, JsonpDeserializer.stringDeserializer(), "timezone");
op.add(Builder::outputFormat, JsonpDeserializer.stringDeserializer(), "output_format");
}
}