co.elastic.clients.elasticsearch.slm.Retention 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.slm;
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.Integer;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: slm._types.Retention
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class Retention implements JsonpSerializable {
private final Time expireAfter;
private final int maxCount;
private final int minCount;
// ---------------------------------------------------------------------------------------------
private Retention(Builder builder) {
this.expireAfter = ApiTypeHelper.requireNonNull(builder.expireAfter, this, "expireAfter");
this.maxCount = ApiTypeHelper.requireNonNull(builder.maxCount, this, "maxCount");
this.minCount = ApiTypeHelper.requireNonNull(builder.minCount, this, "minCount");
}
public static Retention of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - Time period after which a snapshot is considered expired and
* eligible for deletion. SLM deletes expired snapshots based on the
* slm.retention_schedule.
*
* API name: {@code expire_after}
*/
public final Time expireAfter() {
return this.expireAfter;
}
/**
* Required - Maximum number of snapshots to retain, even if the snapshots have
* not yet expired. If the number of snapshots in the repository exceeds this
* limit, the policy retains the most recent snapshots and deletes older
* snapshots.
*
* API name: {@code max_count}
*/
public final int maxCount() {
return this.maxCount;
}
/**
* Required - Minimum number of snapshots to retain, even if the snapshots have
* expired.
*
* API name: {@code min_count}
*/
public final int minCount() {
return this.minCount;
}
/**
* 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("expire_after");
this.expireAfter.serialize(generator, mapper);
generator.writeKey("max_count");
generator.write(this.maxCount);
generator.writeKey("min_count");
generator.write(this.minCount);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link Retention}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
private Time expireAfter;
private Integer maxCount;
private Integer minCount;
/**
* Required - Time period after which a snapshot is considered expired and
* eligible for deletion. SLM deletes expired snapshots based on the
* slm.retention_schedule.
*
* API name: {@code expire_after}
*/
public final Builder expireAfter(Time value) {
this.expireAfter = value;
return this;
}
/**
* Required - Time period after which a snapshot is considered expired and
* eligible for deletion. SLM deletes expired snapshots based on the
* slm.retention_schedule.
*
* API name: {@code expire_after}
*/
public final Builder expireAfter(Function> fn) {
return this.expireAfter(fn.apply(new Time.Builder()).build());
}
/**
* Required - Maximum number of snapshots to retain, even if the snapshots have
* not yet expired. If the number of snapshots in the repository exceeds this
* limit, the policy retains the most recent snapshots and deletes older
* snapshots.
*
* API name: {@code max_count}
*/
public final Builder maxCount(int value) {
this.maxCount = value;
return this;
}
/**
* Required - Minimum number of snapshots to retain, even if the snapshots have
* expired.
*
* API name: {@code min_count}
*/
public final Builder minCount(int value) {
this.minCount = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link Retention}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public Retention build() {
_checkSingleUse();
return new Retention(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link Retention}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
Retention::setupRetentionDeserializer);
protected static void setupRetentionDeserializer(ObjectDeserializer op) {
op.add(Builder::expireAfter, Time._DESERIALIZER, "expire_after");
op.add(Builder::maxCount, JsonpDeserializer.integerDeserializer(), "max_count");
op.add(Builder::minCount, JsonpDeserializer.integerDeserializer(), "min_count");
}
}