Module org.elasticsearch.xcore
Package org.elasticsearch.xpack.core.ilm
package org.elasticsearch.xpack.core.ilm
-
ClassDescriptionChecks whether all shards have been correctly routed in response to an update to the allocation rules for an index.Performs an action which must be performed asynchronously because it may take time to complete.This step changes its
AsyncBranchingStep.getNextStepKey()depending on the outcome of a defined async predicate.This is an abstract AsyncActionStep that wraps the performed action listener, checking to see if the action fails due to a snapshot being in progress.A step which will be called periodically, waiting for some condition to become true.This step changes itsBranchingStep.getNextStepKey()depending on the outcome of a defined predicate.Some actions cannot be executed on a data stream's write index (eg.This step is used prior to running a shrink step in order to ensure that the index being shrunk has a copy of each shard allocated on one particular node (the node used by the require parameter) and that the shards are not relocating.This step checks whether the new shrunken index's shards count is a factor of the source index's shards count.Deletes the index identified by the shrink index name stored in the lifecycle state of the managed index (if any was generated)Deletes the snapshot designated by the repository and snapshot name present in the lifecycle execution state.Invokes a close step on a single index.Updates the cluster state, similar toClusterStateUpdateTask.Checks whether a condition has been met based on the cluster state.This step wraps anClusterStateWaitStepin order to be able to manipulate what the next step will be, depending on the result of the wrappedClusterStateWaitStep.Copies the execution state data from one index to another, typically after a new index has been created.Copy the provided settings from the source to the target index.Creates a snapshot of the managed index into the configured repository and snapshot name.Checks whether all shards have been correctly routed in response to updating the allocation rules for an index in order to migrate the index to a new tier.ALifecycleActionwhich deletes the index.Deletes a single index.ALifecycleActionwhich callsDownsampleActionon an indexAn ILM step that sets the target index to use in theDownsampleStep.ILM step that invokes the downsample action for an index using aDateHistogramInterval.Signals that an error was encountered during the execution of a policy on an index.The request object used by the Explain Lifecycle API.The response object returned by the Explain Lifecycle API.ALifecycleActionwhich force-merges the index.Invokes a force merge on a single index.Deprecated.Generates a snapshot name for the given index and records it in the index metadata along with the provided snapshot repository.Generates a unique index name prefixing the original index name with the configured prefix, concatenated with a random UUID.Initializes theLifecycleExecutionStatefor an index.Exception thrown when a problem is encountered while initialising an ILM policy for an index.Executes an action on an index related to its lifecycle.Class that encapsulates the running operation mode of Index Lifecycle Management and Snapshot Lifecycle ManagementRepresents the lifecycle of an index from creation to deletion.This class wraps a client and calls the client using the headers provided in constructor.A class that can be used to calculate the usages of ILM policies across the cluster.A utility class used for index lifecycle policiesClass encapsulating settings related to Index Lifecycle Management X-Pack PluginALifecycleActionwhich enables or disables the automatic migration of data betweenDataTiers.Restores the snapshot created for the designated index via the ILM policy to an index named using the provided prefix appended to the designated index name.This is a Noop step that can be used for backwards compatibility when removing some step in newer versions.Enum representing the different modes that Index Lifecycle Service can operate in.This task updates the operation mode state for ILM.Represents set ofLifecycleActions which should be executed at a particular point in the lifecycle of an index.We cache the currently executing ILM phase in the index metadata so the ILM execution for managed indices is not irrecoverably interrupted by a concurrent update policy that, say, would remove the current execution phase altogether.This is essentially a marker that a phase has ended, and we need to check the age of an index before proceeding to the next phase.This class contains information about the current phase being executed by Index Lifecycle Management on the specific index.ALifecycleActionwhich sets the index to be read-only.Marks an index as read-only, by setting aIndexMetadata.APIBlock.WRITEblock on the index.This step replaces a data stream backing index with the target index, as part of the data stream's backing indices.ALifecycleActionwhich rolls over the index.Unconditionally rolls over an index using the Rollover API.ALifecycleActionthat will convert the index into a searchable snapshot, by taking a snapshot of the index, creating a searchable snapshot and the corresponding "searchable snapshot index", deleting the original index and swapping its aliases to the newly created searchable snapshot backed index.ThisStepevaluates whether force_merge was successful by checking the segment count.ALifecycleActionwhich sets the index's priority.Allocates all shards in a single index to one node.ALifecycleActionwhich shrinks the index.Following shrinking an index and deleting the original index, this step creates an alias with the same name as the original index which points to the new shrunken index to allow clients to continue to use the original index name without being aware that it has shrunk.Shrinks an index, using a prefix prepended to the original index name for the name of the shrunken index.Verifies that an index was created through a shrink operation, rather than created some other way.Checks whether all shards in a shrunken index have been successfully allocated.Represents one part of the execution of aLifecycleAction.This step swaps all the aliases from the source index to the restored index and deletes the source index.Signals that the policy for an index has been fully executed.Represents the lifecycle of an index from creation to deletion.Converts a CCR following index into a normal, standalone index, once the index is ready to be safely separated.Copies the lifecycle reference date to a new index created by rolling over an alias.Updates the settings for an index.After we performed the index rollover we wait for the configured number of shards for the rolled over index (ie.This step waits for one of the data tiers to be available in the cluster.Wait Step for index based on color.A step that waits until the managed index is no longer a leader index.Waits for at least one rollover condition to be satisfied, using the Rollover API's dry_run option.ALifecycleActionwhich waits for snapshot to be taken (by configured SLM policy).A step that waits for snapshot to be taken by SLM that includes the index in question to ensure we have backup before we delete the index.ThisStepwaits until the `replicate_for` time of a searchable_snapshot action to pass.ThisStepwaits until theIndexSettings.TIME_SERIES_END_TIMEpasses for time series indices.