Package org.elasticsearch.xpack.core.ml.job.persistence

Class AnomalyDetectorsIndex

java.lang.Object

org.elasticsearch.xpack.core.ml.job.persistence.AnomalyDetectorsIndex

public final class AnomalyDetectorsIndex
extends Object

Methods for handling index naming related functions

Method Summary

Modifier and Type	Method	Description
static void	createStateIndexAndAliasIfNecessary(Client client, ClusterState state, IndexNameExpressionResolver resolver, org.elasticsearch.core.TimeValue masterNodeTimeout, ActionListener<Boolean> finalListener)	Creates the .ml-state-000001 index (if necessary) Creates the .ml-state-write alias for the .ml-state-000001 index (if necessary)
static void	createStateIndexAndAliasIfNecessaryAndWaitForYellow(Client client, ClusterState state, IndexNameExpressionResolver resolver, org.elasticsearch.core.TimeValue masterNodeTimeout, ActionListener<Boolean> finalListener)
static String	jobResultsAliasedName(String jobId)	The name of the alias pointing to the indices where the job's results are stored
static String	jobResultsIndexPrefix()
static String	jobStateIndexPattern()	The name pattern to capture all .ml-state prefixed indices
static String	jobStateIndexWriteAlias()	The name of the alias pointing to the appropriate index for writing job state
static String	resultsMapping()
static String	resultsWriteAlias(String jobId)	The name of the alias pointing to the write index for a job
static String	wrappedResultsMapping()
static String	wrappedResultsMapping(String mappingType)

Methods inherited from class java.lang.Object

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

Method Details

jobResultsIndexPrefix

public static String jobResultsIndexPrefix()

jobResultsAliasedName

public static String jobResultsAliasedName(String jobId)

The name of the alias pointing to the indices where the job's results are stored

Parameters:

jobId - Job Id

Returns:

The read alias

resultsWriteAlias

public static String resultsWriteAlias(String jobId)

The name of the alias pointing to the write index for a job

Parameters:

jobId - Job Id

Returns:

The write alias

jobStateIndexWriteAlias

public static String jobStateIndexWriteAlias()

The name of the alias pointing to the appropriate index for writing job state

Returns:

The write alias name

jobStateIndexPattern

public static String jobStateIndexPattern()

The name pattern to capture all .ml-state prefixed indices

Returns:

The .ml-state index pattern

createStateIndexAndAliasIfNecessary

public static void createStateIndexAndAliasIfNecessary(Client client,
 ClusterState state,
 IndexNameExpressionResolver resolver,
 org.elasticsearch.core.TimeValue masterNodeTimeout,
 ActionListener<Boolean> finalListener)

Creates the .ml-state-000001 index (if necessary) Creates the .ml-state-write alias for the .ml-state-000001 index (if necessary)

createStateIndexAndAliasIfNecessaryAndWaitForYellow

public static void createStateIndexAndAliasIfNecessaryAndWaitForYellow(Client client,
 ClusterState state,
 IndexNameExpressionResolver resolver,
 org.elasticsearch.core.TimeValue masterNodeTimeout,
 ActionListener<Boolean> finalListener)

wrappedResultsMapping

public static String wrappedResultsMapping()

wrappedResultsMapping

public static String wrappedResultsMapping(String mappingType)

resultsMapping

public static String resultsMapping()