org.thales.punch.platform.api.pojo

Class ElasticsearchHousekeepingActionSettingPojo

java.lang.Object

org.thales.punch.platform.api.pojo.ElasticsearchHousekeepingActionSettingPojo

public class ElasticsearchHousekeepingActionSettingPojo
extends Object

This describes an Houskeeping action to be conducted on an Elasticsearch cluster

Author:

cedric

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ElasticsearchHousekeepingActionSettingPojo.ActionType The values of this enum are used within Jinja2 template of elasticsearch curator configuration file (see src/main/resources in punchplatform-es-housekeeper-service)

Field Summary

Fields

Modifier and Type	Field and Description
String	box_type This parameter is mandatory and meaningful only with 'relocate_indices' action type.
String	indices_naming_time_format Optional setting.
String	indices_prefix The action will only apply on indices which names start with this prefix.
Integer	new_replica_count This parameter is mandatory and meaningful only with 'change_replica_count' action type.
Integer	older_than_days Optional setting The action will only apply on indices created at least this number of days before now
ElasticsearchHousekeepingActionSettingPojo.ActionType	type The kind of housekeeping action to conduct on indices

Constructor Summary

Constructors

Constructor and Description
ElasticsearchHousekeepingActionSettingPojo()

Method Summary

Modifier and Type	Method and Description
void	validate() The validate method is in charge of checking for mandatory properties, and possibly computing defaults value.

Methods inherited from class java.lang.Object

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

Field Detail

type

public ElasticsearchHousekeepingActionSettingPojo.ActionType type

The kind of housekeeping action to conduct on indices

older_than_days

public Integer older_than_days

Optional setting The action will only apply on indices created at least this number of days before now

indices_naming_time_format

public String indices_naming_time_format

Optional setting.
This setting is meaningful only when used in addition to 'older_than_day' option.

When this option is present, then the condition on the age of the indice will not be applied to actual creation date of the indice, but on the date implied by the name of the indice. The format of date/time inside the indice naming convention is then provided by this option.

This setting must be a valid Python strftime string. It is used to match and extract the timestamp in an index or snapshot name, whatever the place of the date/time string inside the indice name. For more detail on this setting, please refer to https://www.elastic.co/guide/en/elasticsearch/client/curator/current/fe_timestring.html#_strftime_2

indices_prefix

public String indices_prefix

The action will only apply on indices which names start with this prefix.

new_replica_count

public Integer new_replica_count

This parameter is mandatory and meaningful only with 'change_replica_count' action type. A value of 0 means there will be no replica of the primary shards, therefore no resilience to failure of a node bearing a shard of this indice.

box_type

public String box_type

This parameter is mandatory and meaningful only with 'relocate_indices' action type. The value must match one of the values of the 'box_type' tag associated to Elasticsearch nodes in the cluster (See punchplatform.properties). e.g. "hot", "warm", "cold". The action will associate this new value to the 'box_type' allocation tag of the indices. To comply with this allocation tag, Elasticsearch will move the indice to cluster nodes that have the same 'box_type' tag value. This is useful for example if your "hot" nodes have SSDs and your "warm" nodes use magnetic drives for cost reduction.

Constructor Detail

ElasticsearchHousekeepingActionSettingPojo

public ElasticsearchHousekeepingActionSettingPojo()

Method Detail

validate

public void validate()

The validate method is in charge of checking for mandatory properties, and possibly computing defaults value. It is not a generic method, each subclass can implement its own validate method with its parameters.

However make sure at the end you always invoke super.validate()