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

Class DataStreamLifecycleUsage.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch.xpack.usage.Base.AbstractBuilder<DataStreamLifecycleUsage.Builder>

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

All Implemented Interfaces:

WithJson<DataStreamLifecycleUsage.Builder>, ObjectBuilder<DataStreamLifecycleUsage>

Enclosing class:

DataStreamLifecycleUsage

public static class DataStreamLifecycleUsage.Builder
extends Base.AbstractBuilder<DataStreamLifecycleUsage.Builder>
implements ObjectBuilder<DataStreamLifecycleUsage>

Builder for DataStreamLifecycleUsage.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

available, enabled

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

count

public final DataStreamLifecycleUsage.Builder count(@Nullable
 Long value)

The number of data streams that have a lifecycle configured.

API name: count

defaultRolloverUsed

public final DataStreamLifecycleUsage.Builder defaultRolloverUsed(@Nullable
 Boolean value)

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

API name: default_rollover_used

dataRetention

public final DataStreamLifecycleUsage.Builder dataRetention(@Nullable
 DataStreamLifecycleRetentionStats value)

Statistics about the explicitly configured data retention across data streams.

API name: data_retention

dataRetention

public final DataStreamLifecycleUsage.Builder dataRetention(Function<DataStreamLifecycleRetentionStats.Builder,ObjectBuilder<DataStreamLifecycleRetentionStats>> fn)

Statistics about the explicitly configured data retention across data streams.

API name: data_retention

effectiveRetention

public final DataStreamLifecycleUsage.Builder effectiveRetention(@Nullable
 DataStreamLifecycleEffectiveRetentionStats value)

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

API name: effective_retention

effectiveRetention

public final DataStreamLifecycleUsage.Builder effectiveRetention(Function<DataStreamLifecycleEffectiveRetentionStats.Builder,ObjectBuilder<DataStreamLifecycleEffectiveRetentionStats>> fn)

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

API name: effective_retention

frozenAfter

public final DataStreamLifecycleUsage.Builder frozenAfter(@Nullable
 DataStreamLifecycleRetentionStats value)

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

API name: frozen_after

frozenAfter

public final DataStreamLifecycleUsage.Builder frozenAfter(Function<DataStreamLifecycleRetentionStats.Builder,ObjectBuilder<DataStreamLifecycleRetentionStats>> fn)

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

API name: frozen_after

globalRetention

public final DataStreamLifecycleUsage.Builder globalRetention(@Nullable
 DataStreamLifecycleGlobalRetention value)

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

API name: global_retention

globalRetention

public final DataStreamLifecycleUsage.Builder globalRetention(Function<DataStreamLifecycleGlobalRetention.Builder,ObjectBuilder<DataStreamLifecycleGlobalRetention>> fn)

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

API name: global_retention

self

protected DataStreamLifecycleUsage.Builder self()

Specified by:

self in class Base.AbstractBuilder<DataStreamLifecycleUsage.Builder>

build

public DataStreamLifecycleUsage build()

Builds a DataStreamLifecycleUsage.

Specified by:

build in interface ObjectBuilder<DataStreamLifecycleUsage>

Throws:

NullPointerException - if some of the required fields are null.