Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.slm

Class SnapshotLifecyclePolicy

java.lang.Object

org.elasticsearch.xpack.core.slm.SnapshotLifecyclePolicy

All Implemented Interfaces:

Diffable<SnapshotLifecyclePolicy>, SimpleDiffable<SnapshotLifecyclePolicy>, Writeable, ToXContent, ToXContentObject

public class SnapshotLifecyclePolicy
extends Object
implements SimpleDiffable<SnapshotLifecyclePolicy>, Writeable, ToXContentObject

A SnapshotLifecyclePolicy is a policy for the cluster including a schedule of when a snapshot should be triggered, what the snapshot should be named, what repository it should go to, and the configuration for the snapshot itself.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.cluster.SimpleDiffable

SimpleDiffable.CompleteDiff<T extends Diffable<T>>

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 inherited from interface org.elasticsearch.cluster.SimpleDiffable

EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SnapshotLifecyclePolicy(String id, String name, String schedule, String repository, Map<String,Object> configuration, SnapshotRetentionConfiguration retentionPolicy)
SnapshotLifecyclePolicy(String id, String name, String schedule, String repository, Map<String,Object> configuration, SnapshotRetentionConfiguration retentionPolicy, TimeValue unhealthyIfNoSnapshotWithin)
SnapshotLifecyclePolicy(StreamInput in)

Method Summary

Modifier and Type	Method	Description
SchedulerEngine.Job	buildSchedulerJob(String jobId, long modifiedDate)
long	calculateNextExecution(long modifiedDate, Clock clock)
TimeValue	calculateNextInterval(Clock clock)	Calculate the difference between the next two valid times after now for the schedule.
boolean	equals(Object obj)
Map<String,Object>	getConfig()
String	getId()
String	getName()
String	getRepository()
SnapshotRetentionConfiguration	getRetentionPolicy()
String	getSchedule()
TimeValue	getUnhealthyIfNoSnapshotWithin()
int	hashCode()
static boolean	isIntervalSchedule(String schedule)
static SnapshotLifecyclePolicy	parse(XContentParser parser, String id)
CreateSnapshotRequest	toRequest(TimeValue masterNodeTimeout)	Generate a new create snapshot request from this policy.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException	validate()
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.cluster.SimpleDiffable

diff

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

SnapshotLifecyclePolicy

public SnapshotLifecyclePolicy(String id,
 String name,
 String schedule,
 String repository,
 @Nullable
 Map<String,Object> configuration,
 @Nullable
 SnapshotRetentionConfiguration retentionPolicy)

SnapshotLifecyclePolicy

public SnapshotLifecyclePolicy(String id,
 String name,
 String schedule,
 String repository,
 @Nullable
 Map<String,Object> configuration,
 @Nullable
 SnapshotRetentionConfiguration retentionPolicy,
 @Nullable
 TimeValue unhealthyIfNoSnapshotWithin)

SnapshotLifecyclePolicy

public SnapshotLifecyclePolicy(StreamInput in)
                        throws IOException

Throws:

IOException

Method Details

getId

public String getId()

getName

public String getName()

getSchedule

public String getSchedule()

getRepository

public String getRepository()

getConfig

@Nullable
public Map<String,Object> getConfig()

getRetentionPolicy

@Nullable
public SnapshotRetentionConfiguration getRetentionPolicy()

getUnhealthyIfNoSnapshotWithin

@Nullable
public TimeValue getUnhealthyIfNoSnapshotWithin()

isIntervalSchedule

public static boolean isIntervalSchedule(String schedule)

Returns:

whether `schedule` is an interval time unit expression

calculateNextExecution

public long calculateNextExecution(long modifiedDate,
 Clock clock)

calculateNextInterval

public TimeValue calculateNextInterval(Clock clock)

Calculate the difference between the next two valid times after now for the schedule.

In ordinary cases, this can be treated as the interval between executions of the schedule (for schedules like 'twice an hour' or 'every five minutes').

Parameters:

clock - a clock to provide current time

Returns:

a TimeValue representing the difference between the next two valid times after now, or TimeValue.MINUS_ONE if either of the next two times after now is unsupported according to @Cron.getNextValidTimeAfter(long)

buildSchedulerJob

public SchedulerEngine.Job buildSchedulerJob(String jobId,
 long modifiedDate)

validate

public ActionRequestValidationException validate()

toRequest

public CreateSnapshotRequest toRequest(TimeValue masterNodeTimeout)

Generate a new create snapshot request from this policy. The name of the snapshot is generated at this time based on any date math expressions in the "name" field.

parse

public static SnapshotLifecyclePolicy parse(XContentParser parser,
 String id)

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