Module org.elasticsearch.server

Package org.elasticsearch.action.admin.indices.rollover

Class RolloverConfiguration

java.lang.Object

org.elasticsearch.action.admin.indices.rollover.RolloverConfiguration

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class RolloverConfiguration
extends Object
implements Writeable, ToXContentObject

This class holds the configuration of the rollover conditions as they are defined in data stream lifecycle. Currently, it can handle automatic configuration for the max index age condition.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RolloverConfiguration.ValueParser	Parses and keeps track of the condition values during parsing

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.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RolloverConfiguration(RolloverConditions concreteConditions)
RolloverConfiguration(RolloverConditions concreteConditions, Set<String> automaticConditions)
RolloverConfiguration(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
XContentBuilder	evaluateAndConvertToXContent(XContentBuilder builder, ToXContent.Params params, TimeValue retention)	Evaluates the automatic conditions and converts the whole configuration to XContent.
Set<String>	getAutomaticConditions()
RolloverConditions	getConcreteConditions()
int	hashCode()
static RolloverConfiguration	parseSetting(String input, String setting)	Parses a cluster setting configuration, it expects it to have the following format: "condition1=value1,condition2=value2"
RolloverConditions	resolveRolloverConditions(TimeValue dataRetention)	Evaluates all the automatic conditions based on the provided arguments.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

RolloverConfiguration

public RolloverConfiguration(RolloverConditions concreteConditions,
 Set<String> automaticConditions)

RolloverConfiguration

public RolloverConfiguration(RolloverConditions concreteConditions)

RolloverConfiguration

public RolloverConfiguration(StreamInput in)
                      throws IOException

Throws:

IOException

Method Details

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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

evaluateAndConvertToXContent

public XContentBuilder evaluateAndConvertToXContent(XContentBuilder builder,
 ToXContent.Params params,
 @Nullable
 TimeValue retention)
                                             throws IOException

Evaluates the automatic conditions and converts the whole configuration to XContent. For the automatic conditions is also adds the suffix [automatic]

Throws:

IOException

resolveRolloverConditions

public RolloverConditions resolveRolloverConditions(@Nullable
 TimeValue dataRetention)

Evaluates all the automatic conditions based on the provided arguments.

getConcreteConditions

public RolloverConditions getConcreteConditions()

getAutomaticConditions

public Set<String> getAutomaticConditions()

parseSetting

public static RolloverConfiguration parseSetting(String input,
 String setting)

Parses a cluster setting configuration, it expects it to have the following format: "condition1=value1,condition2=value2"

Throws:

SettingsException - if the input is invalid, if there are unknown conditions or invalid format values.

IllegalArgumentException - if the input is null or blank.

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