co.elastic.clients.elasticsearch.ml.DataDescription 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.ml;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.JsonpUtils;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.String;
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: ml._types.DataDescription
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class DataDescription implements JsonpSerializable {
@Nullable
private final String format;
@Nullable
private final String timeField;
@Nullable
private final String timeFormat;
@Nullable
private final String fieldDelimiter;
// ---------------------------------------------------------------------------------------------
private DataDescription(Builder builder) {
this.format = builder.format;
this.timeField = builder.timeField;
this.timeFormat = builder.timeFormat;
this.fieldDelimiter = builder.fieldDelimiter;
}
public static DataDescription of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Only JSON format is supported at this time.
*
* API name: {@code format}
*/
@Nullable
public final String format() {
return this.format;
}
/**
* The name of the field that contains the timestamp.
*
* API name: {@code time_field}
*/
@Nullable
public final String timeField() {
return this.timeField;
}
/**
* The time format, which can be epoch, epoch_ms, or a
* custom pattern. The value epoch refers to UNIX or Epoch time
* (the number of seconds since 1 Jan 1970). The value epoch_ms
* indicates that time is measured in milliseconds since the epoch. The
* epoch and epoch_ms time formats accept either
* integer or real values. Custom patterns must conform to the Java
* DateTimeFormatter class. When you use date-time formatting patterns, it is
* recommended that you provide the full date, time and time zone. For example:
* yyyy-MM-dd'T'HH:mm:ssX. If the pattern that you specify is not
* sufficient to produce a complete timestamp, job creation fails.
*
* API name: {@code time_format}
*/
@Nullable
public final String timeFormat() {
return this.timeFormat;
}
/**
* API name: {@code field_delimiter}
*/
@Nullable
public final String fieldDelimiter() {
return this.fieldDelimiter;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
if (this.format != null) {
generator.writeKey("format");
generator.write(this.format);
}
if (this.timeField != null) {
generator.writeKey("time_field");
generator.write(this.timeField);
}
if (this.timeFormat != null) {
generator.writeKey("time_format");
generator.write(this.timeFormat);
}
if (this.fieldDelimiter != null) {
generator.writeKey("field_delimiter");
generator.write(this.fieldDelimiter);
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link DataDescription}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
@Nullable
private String format;
@Nullable
private String timeField;
@Nullable
private String timeFormat;
@Nullable
private String fieldDelimiter;
/**
* Only JSON format is supported at this time.
*
* API name: {@code format}
*/
public final Builder format(@Nullable String value) {
this.format = value;
return this;
}
/**
* The name of the field that contains the timestamp.
*
* API name: {@code time_field}
*/
public final Builder timeField(@Nullable String value) {
this.timeField = value;
return this;
}
/**
* The time format, which can be epoch, epoch_ms, or a
* custom pattern. The value epoch refers to UNIX or Epoch time
* (the number of seconds since 1 Jan 1970). The value epoch_ms
* indicates that time is measured in milliseconds since the epoch. The
* epoch and epoch_ms time formats accept either
* integer or real values. Custom patterns must conform to the Java
* DateTimeFormatter class. When you use date-time formatting patterns, it is
* recommended that you provide the full date, time and time zone. For example:
* yyyy-MM-dd'T'HH:mm:ssX. If the pattern that you specify is not
* sufficient to produce a complete timestamp, job creation fails.
*
* API name: {@code time_format}
*/
public final Builder timeFormat(@Nullable String value) {
this.timeFormat = value;
return this;
}
/**
* API name: {@code field_delimiter}
*/
public final Builder fieldDelimiter(@Nullable String value) {
this.fieldDelimiter = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link DataDescription}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public DataDescription build() {
_checkSingleUse();
return new DataDescription(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link DataDescription}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
DataDescription::setupDataDescriptionDeserializer);
protected static void setupDataDescriptionDeserializer(ObjectDeserializer op) {
op.add(Builder::format, JsonpDeserializer.stringDeserializer(), "format");
op.add(Builder::timeField, JsonpDeserializer.stringDeserializer(), "time_field");
op.add(Builder::timeFormat, JsonpDeserializer.stringDeserializer(), "time_format");
op.add(Builder::fieldDelimiter, JsonpDeserializer.stringDeserializer(), "field_delimiter");
}
}