Package co.elastic.clients.elasticsearch.xpack.usage

Class DataStreamLifecycleUsage

java.lang.Object

co.elastic.clients.elasticsearch.xpack.usage.Base

co.elastic.clients.elasticsearch.xpack.usage.DataStreamLifecycleUsage

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class DataStreamLifecycleUsage
extends Base

Usage statistics for data stream lifecycle (DLM), reported by _xpack/usage under data_lifecycle. Besides available and enabled, all the following statistics are only present when the feature is enabled.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataStreamLifecycleUsage.Builder	Builder for DataStreamLifecycleUsage.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.xpack.usage.Base

Base.AbstractBuilder<BuilderT extends Base.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<DataStreamLifecycleUsage>	_DESERIALIZER	Json deserializer for DataStreamLifecycleUsage

Method Summary

Modifier and Type	Method	Description
final Long	count()	The number of data streams that have a lifecycle configured.
final DataStreamLifecycleRetentionStats	dataRetention()	Statistics about the explicitly configured data retention across data streams.
final Boolean	defaultRolloverUsed()	Whether the default rollover configuration is used by at least one data stream.
final DataStreamLifecycleEffectiveRetentionStats	effectiveRetention()	Statistics about the effective retention (configured or derived from global retention) across data streams.
final DataStreamLifecycleRetentionStats	frozenAfter()	Statistics about the configured frozen_after (searchable snapshot) tier threshold across data streams.
final DataStreamLifecycleGlobalRetention	globalRetention()	Statistics about the cluster's global default and maximum retention settings.
static DataStreamLifecycleUsage	of(Function<DataStreamLifecycleUsage.Builder,ObjectBuilder<DataStreamLifecycleUsage>> fn)
DataStreamLifecycleUsage.Builder	rebuild()
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupDataStreamLifecycleUsageDeserializer(ObjectDeserializer<DataStreamLifecycleUsage.Builder> op)

Methods inherited from class co.elastic.clients.elasticsearch.xpack.usage.Base

available, baseOf, enabled, serialize, setupBaseDeserializer, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<DataStreamLifecycleUsage> _DESERIALIZER

Json deserializer for DataStreamLifecycleUsage

Method Details

of

public static DataStreamLifecycleUsage of(Function<DataStreamLifecycleUsage.Builder,ObjectBuilder<DataStreamLifecycleUsage>> fn)

count

@Nullable
public final Long count()

The number of data streams that have a lifecycle configured.

API name: count

defaultRolloverUsed

@Nullable
public final Boolean defaultRolloverUsed()

Whether the default rollover configuration is used by at least one data stream.

API name: default_rollover_used

dataRetention

@Nullable
public final DataStreamLifecycleRetentionStats dataRetention()

Statistics about the explicitly configured data retention across data streams.

API name: data_retention

effectiveRetention

@Nullable
public final DataStreamLifecycleEffectiveRetentionStats effectiveRetention()

Statistics about the effective retention (configured or derived from global retention) across data streams.

API name: effective_retention

frozenAfter

@Nullable
public final DataStreamLifecycleRetentionStats frozenAfter()

Statistics about the configured frozen_after (searchable snapshot) tier threshold across data streams.

API name: frozen_after

globalRetention

@Nullable
public final DataStreamLifecycleGlobalRetention globalRetention()

Statistics about the cluster's global default and maximum retention settings.

API name: global_retention

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class Base

rebuild

public DataStreamLifecycleUsage.Builder rebuild()

Returns:

New DataStreamLifecycleUsage.Builder initialized with field values of this instance

setupDataStreamLifecycleUsageDeserializer

protected static void setupDataStreamLifecycleUsageDeserializer(ObjectDeserializer<DataStreamLifecycleUsage.Builder> op)