co.elastic.clients.elasticsearch.ml.ChunkingConfig 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.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.JsonpUtils;
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.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.ChunkingConfig
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class ChunkingConfig implements JsonpSerializable {
private final ChunkingMode mode;
@Nullable
private final Time timeSpan;
// ---------------------------------------------------------------------------------------------
private ChunkingConfig(Builder builder) {
this.mode = ApiTypeHelper.requireNonNull(builder.mode, this, "mode");
this.timeSpan = builder.timeSpan;
}
public static ChunkingConfig of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - If the mode is auto, the chunk size is dynamically
* calculated; this is the recommended value when the datafeed does not use
* aggregations. If the mode is manual, chunking is applied
* according to the specified time_span; use this mode when the
* datafeed uses aggregations. If the mode is off, no chunking is
* applied.
*
* API name: {@code mode}
*/
public final ChunkingMode mode() {
return this.mode;
}
/**
* The time span that each search will be querying. This setting is applicable
* only when the mode is set to manual.
*
* API name: {@code time_span}
*/
@Nullable
public final Time timeSpan() {
return this.timeSpan;
}
/**
* 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) {
generator.writeKey("mode");
this.mode.serialize(generator, mapper);
if (this.timeSpan != null) {
generator.writeKey("time_span");
this.timeSpan.serialize(generator, mapper);
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link ChunkingConfig}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
private ChunkingMode mode;
@Nullable
private Time timeSpan;
/**
* Required - If the mode is auto, the chunk size is dynamically
* calculated; this is the recommended value when the datafeed does not use
* aggregations. If the mode is manual, chunking is applied
* according to the specified time_span; use this mode when the
* datafeed uses aggregations. If the mode is off, no chunking is
* applied.
*
* API name: {@code mode}
*/
public final Builder mode(ChunkingMode value) {
this.mode = value;
return this;
}
/**
* The time span that each search will be querying. This setting is applicable
* only when the mode is set to manual.
*
* API name: {@code time_span}
*/
public final Builder timeSpan(@Nullable Time value) {
this.timeSpan = value;
return this;
}
/**
* The time span that each search will be querying. This setting is applicable
* only when the mode is set to manual.
*
* API name: {@code time_span}
*/
public final Builder timeSpan(Function> fn) {
return this.timeSpan(fn.apply(new Time.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link ChunkingConfig}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public ChunkingConfig build() {
_checkSingleUse();
return new ChunkingConfig(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link ChunkingConfig}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
ChunkingConfig::setupChunkingConfigDeserializer);
protected static void setupChunkingConfigDeserializer(ObjectDeserializer op) {
op.add(Builder::mode, ChunkingMode._DESERIALIZER, "mode");
op.add(Builder::timeSpan, Time._DESERIALIZER, "time_span");
}
}