co.elastic.clients.elasticsearch.ml.DelayedDataCheckConfig 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.
*/
//----------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------
package co.elastic.clients.elasticsearch.ml;
import co.elastic.clients.elasticsearch._types.Time;
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.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: ml._types.DelayedDataCheckConfig
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class DelayedDataCheckConfig implements JsonpSerializable {
@Nullable
private final Time checkWindow;
private final boolean enabled;
// ---------------------------------------------------------------------------------------------
private DelayedDataCheckConfig(Builder builder) {
this.checkWindow = builder.checkWindow;
this.enabled = ApiTypeHelper.requireNonNull(builder.enabled, this, "enabled");
}
public static DelayedDataCheckConfig of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* The window of time that is searched for late data. This window of time ends
* with the latest finalized bucket. It defaults to null, which causes an
* appropriate check_window to be calculated when the real-time
* datafeed runs. In particular, the default check_window span
* calculation is based on the maximum of 2h or
* 8 * bucket_span.
*
* API name: {@code check_window}
*/
@Nullable
public final Time checkWindow() {
return this.checkWindow;
}
/**
* Required - Specifies whether the datafeed periodically checks for delayed
* data.
*
* API name: {@code enabled}
*/
public final boolean enabled() {
return this.enabled;
}
/**
* 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.checkWindow != null) {
generator.writeKey("check_window");
this.checkWindow.serialize(generator, mapper);
}
generator.writeKey("enabled");
generator.write(this.enabled);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link DelayedDataCheckConfig}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
@Nullable
private Time checkWindow;
private Boolean enabled;
/**
* The window of time that is searched for late data. This window of time ends
* with the latest finalized bucket. It defaults to null, which causes an
* appropriate check_window to be calculated when the real-time
* datafeed runs. In particular, the default check_window span
* calculation is based on the maximum of 2h or
* 8 * bucket_span.
*
* API name: {@code check_window}
*/
public final Builder checkWindow(@Nullable Time value) {
this.checkWindow = value;
return this;
}
/**
* The window of time that is searched for late data. This window of time ends
* with the latest finalized bucket. It defaults to null, which causes an
* appropriate check_window to be calculated when the real-time
* datafeed runs. In particular, the default check_window span
* calculation is based on the maximum of 2h or
* 8 * bucket_span.
*
* API name: {@code check_window}
*/
public final Builder checkWindow(Function> fn) {
return this.checkWindow(fn.apply(new Time.Builder()).build());
}
/**
* Required - Specifies whether the datafeed periodically checks for delayed
* data.
*
* API name: {@code enabled}
*/
public final Builder enabled(boolean value) {
this.enabled = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link DelayedDataCheckConfig}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public DelayedDataCheckConfig build() {
_checkSingleUse();
return new DelayedDataCheckConfig(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link DelayedDataCheckConfig}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, DelayedDataCheckConfig::setupDelayedDataCheckConfigDeserializer);
protected static void setupDelayedDataCheckConfigDeserializer(
ObjectDeserializer op) {
op.add(Builder::checkWindow, Time._DESERIALIZER, "check_window");
op.add(Builder::enabled, JsonpDeserializer.booleanDeserializer(), "enabled");
}
}