Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.slm

Class SnapshotRetentionConfiguration

java.lang.Object

org.elasticsearch.xpack.core.slm.SnapshotRetentionConfiguration

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class SnapshotRetentionConfiguration
extends Object
implements ToXContentObject, Writeable

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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 SnapshotRetentionConfiguration	EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SnapshotRetentionConfiguration(LongSupplier nowSupplier, TimeValue expireAfter, Integer minimumSnapshotCount, Integer maximumSnapshotCount)
SnapshotRetentionConfiguration(TimeValue expireAfter, Integer minimumSnapshotCount, Integer maximumSnapshotCount)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	hashCode()
boolean	isSnapshotEligibleForDeletion(SnapshotId snapshotId, RepositoryData.SnapshotDetails snapshotDetails, Map<SnapshotId,RepositoryData.SnapshotDetails> allSnapshots)
static SnapshotRetentionConfiguration	parse(XContentParser parser, String name)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

EMPTY

public static final SnapshotRetentionConfiguration EMPTY

Constructor Details

SnapshotRetentionConfiguration

public SnapshotRetentionConfiguration(@Nullable
 TimeValue expireAfter,
 @Nullable
 Integer minimumSnapshotCount,
 @Nullable
 Integer maximumSnapshotCount)

SnapshotRetentionConfiguration

public SnapshotRetentionConfiguration(LongSupplier nowSupplier,
 @Nullable
 TimeValue expireAfter,
 @Nullable
 Integer minimumSnapshotCount,
 @Nullable
 Integer maximumSnapshotCount)

Method Details

parse

public static SnapshotRetentionConfiguration parse(XContentParser parser,
 String name)

isSnapshotEligibleForDeletion

public boolean isSnapshotEligibleForDeletion(SnapshotId snapshotId,
 RepositoryData.SnapshotDetails snapshotDetails,
 Map<SnapshotId,RepositoryData.SnapshotDetails> allSnapshots)

Parameters:

allSnapshots - all the snapshot details pertaining to this SLM policy and repository

Returns:

whether a snapshot should be deleted according to this retention policy.

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object