Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Class DataStreamGlobalRetention

java.lang.Object

org.elasticsearch.cluster.AbstractNamedDiffable<ClusterState.Custom>

org.elasticsearch.cluster.metadata.DataStreamGlobalRetention

All Implemented Interfaces:

ClusterState.Custom, Diffable<ClusterState.Custom>, NamedDiffable<ClusterState.Custom>, NamedWriteable, VersionedNamedWriteable, Writeable, ChunkedToXContent

public final class DataStreamGlobalRetention
extends AbstractNamedDiffable<ClusterState.Custom>
implements ClusterState.Custom

A cluster state entry that contains global retention settings that are configurable by the user. These settings include: - default retention, applied on any data stream managed by DSL that does not have an explicit retention defined - max retention, applied on every data stream managed by DSL

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	DEFAULT_RETENTION_FIELD
static final DataStreamGlobalRetention	EMPTY
static final NodeFeature	GLOBAL_RETENTION
static final ParseField	MAX_RETENTION_FIELD
static final TimeValue	MIN_RETENTION_VALUE
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
DataStreamGlobalRetention(TimeValue defaultRetention, TimeValue maxRetention)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
TimeValue	getDefaultRetention()
static DataStreamGlobalRetention	getFromClusterState(ClusterState clusterState)	Returns the metadata found in the cluster state or null.
TimeValue	getMaxRetention()
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
static DataStreamGlobalRetention	read(StreamInput in)
static NamedDiff<ClusterState.Custom>	readDiffFrom(StreamInput in)
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params ignored)	Serialize this ClusterState.Custom for diagnostic purposes, exposed by the
XContentBuilder	toXContentFragment(XContentBuilder builder, ToXContent.Params params)	Adds to the XContentBuilder the two fields when they are not null.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.cluster.AbstractNamedDiffable

diff, get, readDiffFrom

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ChunkedToXContent

isFragment, toXContentChunkedV7

Methods inherited from interface org.elasticsearch.cluster.ClusterState.Custom

isPrivate

Methods inherited from interface org.elasticsearch.cluster.Diffable

diff

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

GLOBAL_RETENTION

public static final NodeFeature GLOBAL_RETENTION

DEFAULT_RETENTION_FIELD

public static final ParseField DEFAULT_RETENTION_FIELD

MAX_RETENTION_FIELD

public static final ParseField MAX_RETENTION_FIELD

EMPTY

public static final DataStreamGlobalRetention EMPTY

MIN_RETENTION_VALUE

public static final TimeValue MIN_RETENTION_VALUE

Constructor Details

DataStreamGlobalRetention

public DataStreamGlobalRetention(TimeValue defaultRetention,
 TimeValue maxRetention)

Parameters:

defaultRetention - the default retention or null if it's undefined

maxRetention - the max retention or null if it's undefined

Throws:

IllegalArgumentException - when the default retention is greater than the max retention.

Method Details

read

public static DataStreamGlobalRetention read(StreamInput in)
                                      throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

readDiffFrom

public static NamedDiff<ClusterState.Custom> readDiffFrom(StreamInput in)
                                                   throws IOException

Throws:

IOException

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params ignored)

Description copied from interface: ClusterState.Custom

Serialize this ClusterState.Custom for diagnostic purposes, exposed by the

GET _cluster/state

API etc. The XContent representation does not need to be 100% faithful since we never reconstruct a cluster state from its XContent representation, but the more faithful it is the more useful it is for diagnostics.

Specified by:

toXContentChunked in interface ChunkedToXContent

Specified by:

toXContentChunked in interface ClusterState.Custom

Returns:

iterator over chunks of ToXContent

toXContentFragment

public XContentBuilder toXContentFragment(XContentBuilder builder,
 ToXContent.Params params)
                                   throws IOException

Adds to the XContentBuilder the two fields when they are not null.

Throws:

IOException

getFromClusterState

public static DataStreamGlobalRetention getFromClusterState(ClusterState clusterState)

Returns the metadata found in the cluster state or null.

getDefaultRetention

@Nullable
public TimeValue getDefaultRetention()

getMaxRetention

@Nullable
public TimeValue getMaxRetention()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object