co.elastic.clients.elasticsearch.indices.data_streams_stats.DataStreamsStatsItem 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.indices.data_streams_stats;
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.lang.Integer;
import java.lang.Long;
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: indices.data_streams_stats.DataStreamsStatsItem
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class DataStreamsStatsItem implements JsonpSerializable {
private final int backingIndices;
private final String dataStream;
private final long maximumTimestamp;
@Nullable
private final String storeSize;
private final long storeSizeBytes;
// ---------------------------------------------------------------------------------------------
private DataStreamsStatsItem(Builder builder) {
this.backingIndices = ApiTypeHelper.requireNonNull(builder.backingIndices, this, "backingIndices");
this.dataStream = ApiTypeHelper.requireNonNull(builder.dataStream, this, "dataStream");
this.maximumTimestamp = ApiTypeHelper.requireNonNull(builder.maximumTimestamp, this, "maximumTimestamp");
this.storeSize = builder.storeSize;
this.storeSizeBytes = ApiTypeHelper.requireNonNull(builder.storeSizeBytes, this, "storeSizeBytes");
}
public static DataStreamsStatsItem of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - Current number of backing indices for the data stream.
*
* API name: {@code backing_indices}
*/
public final int backingIndices() {
return this.backingIndices;
}
/**
* Required - Name of the data stream.
*
* API name: {@code data_stream}
*/
public final String dataStream() {
return this.dataStream;
}
/**
* Required - The data stream’s highest @timestamp value, converted
* to milliseconds since the Unix epoch. NOTE: This timestamp is provided as a
* best effort. The data stream may contain @timestamp values
* higher than this if one or more of the following conditions are met: The
* stream contains closed backing indices; Backing indices with a lower
* generation contain higher @timestamp values.
*
* API name: {@code maximum_timestamp}
*/
public final long maximumTimestamp() {
return this.maximumTimestamp;
}
/**
* Total size of all shards for the data stream’s backing indices. This
* parameter is only returned if the human query parameter is
* true.
*
* API name: {@code store_size}
*/
@Nullable
public final String storeSize() {
return this.storeSize;
}
/**
* Required - Total size, in bytes, of all shards for the data stream’s backing
* indices.
*
* API name: {@code store_size_bytes}
*/
public final long storeSizeBytes() {
return this.storeSizeBytes;
}
/**
* 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("backing_indices");
generator.write(this.backingIndices);
generator.writeKey("data_stream");
generator.write(this.dataStream);
generator.writeKey("maximum_timestamp");
generator.write(this.maximumTimestamp);
if (this.storeSize != null) {
generator.writeKey("store_size");
generator.write(this.storeSize);
}
generator.writeKey("store_size_bytes");
generator.write(this.storeSizeBytes);
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link DataStreamsStatsItem}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
private Integer backingIndices;
private String dataStream;
private Long maximumTimestamp;
@Nullable
private String storeSize;
private Long storeSizeBytes;
/**
* Required - Current number of backing indices for the data stream.
*
* API name: {@code backing_indices}
*/
public final Builder backingIndices(int value) {
this.backingIndices = value;
return this;
}
/**
* Required - Name of the data stream.
*
* API name: {@code data_stream}
*/
public final Builder dataStream(String value) {
this.dataStream = value;
return this;
}
/**
* Required - The data stream’s highest @timestamp value, converted
* to milliseconds since the Unix epoch. NOTE: This timestamp is provided as a
* best effort. The data stream may contain @timestamp values
* higher than this if one or more of the following conditions are met: The
* stream contains closed backing indices; Backing indices with a lower
* generation contain higher @timestamp values.
*
* API name: {@code maximum_timestamp}
*/
public final Builder maximumTimestamp(long value) {
this.maximumTimestamp = value;
return this;
}
/**
* Total size of all shards for the data stream’s backing indices. This
* parameter is only returned if the human query parameter is
* true.
*
* API name: {@code store_size}
*/
public final Builder storeSize(@Nullable String value) {
this.storeSize = value;
return this;
}
/**
* Required - Total size, in bytes, of all shards for the data stream’s backing
* indices.
*
* API name: {@code store_size_bytes}
*/
public final Builder storeSizeBytes(long value) {
this.storeSizeBytes = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link DataStreamsStatsItem}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public DataStreamsStatsItem build() {
_checkSingleUse();
return new DataStreamsStatsItem(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link DataStreamsStatsItem}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, DataStreamsStatsItem::setupDataStreamsStatsItemDeserializer);
protected static void setupDataStreamsStatsItemDeserializer(ObjectDeserializer op) {
op.add(Builder::backingIndices, JsonpDeserializer.integerDeserializer(), "backing_indices");
op.add(Builder::dataStream, JsonpDeserializer.stringDeserializer(), "data_stream");
op.add(Builder::maximumTimestamp, JsonpDeserializer.longDeserializer(), "maximum_timestamp");
op.add(Builder::storeSize, JsonpDeserializer.stringDeserializer(), "store_size");
op.add(Builder::storeSizeBytes, JsonpDeserializer.longDeserializer(), "store_size_bytes");
}
}