Module org.elasticsearch.xcore

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	RESULTS_INDEX_MAPPINGS_VERSION

Method Summary

Modifier and Type	Method	Description
static void	createStateIndexAndAliasIfNecessary(Client client, ClusterState state, IndexNameExpressionResolver resolver, TimeValue masterNodeTimeout, ActionListener<Boolean> finalListener)	Deprecated, for removal: This API element is subject to removal in a future version. Use createStateIndexAndAliasIfNecessary(Client, ProjectMetadata, IndexNameExpressionResolver, TimeValue, ActionListener)
static void	createStateIndexAndAliasIfNecessary(Client client, ProjectMetadata projectMetadata, IndexNameExpressionResolver resolver, 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, TimeValue masterNodeTimeout, ActionListener<Boolean> finalListener)	Deprecated, for removal: This API element is subject to removal in a future version. Use createStateIndexAndAliasIfNecessaryAndWaitForYellow(Client, ProjectMetadata, IndexNameExpressionResolver, TimeValue, ActionListener)
static void	createStateIndexAndAliasIfNecessaryAndWaitForYellow(Client client, ProjectMetadata projectMetadata, IndexNameExpressionResolver resolver, TimeValue masterNodeTimeout, ActionListener<Boolean> finalListener)
static Optional<String>	jobIdFromAlias(String jobResultsAliasedName)	Extract the job Id from the alias name.
static String	jobResultsAliasedName(String jobId)	The name of the alias pointing to the indices where the job's results are stored
static String	jobResultsIndexPattern()
static String	jobResultsIndexPrefix()
static String	jobStateIndexPattern()	Comma-separated index patterns for ML state indices for REST query strings that split on commas.
static String[]	jobStateIndexPatterns()	Index patterns for ML state indices, including those created by major-version system-index reindex migration (for example .reindexed-v8-ml-state-000001).
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()

Methods inherited from class java.lang.Object

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

Field Details

RESULTS_INDEX_MAPPINGS_VERSION

public static final int RESULTS_INDEX_MAPPINGS_VERSION

See Also:

• Constant Field Values

Method Details

jobResultsIndexPrefix

public static String jobResultsIndexPrefix()

jobResultsIndexPattern

public static String jobResultsIndexPattern()

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

jobIdFromAlias

public static Optional<String> jobIdFromAlias(String jobResultsAliasedName)

Extract the job Id from the alias name. If not an results index alias null is returned

Parameters:

jobResultsAliasedName - The alias

Returns:

The job Id

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

jobStateIndexPatterns

public static String[] jobStateIndexPatterns()

Index patterns for ML state indices, including those created by major-version system-index reindex migration (for example .reindexed-v8-ml-state-000001).

Use this array with IndexNameExpressionResolver.concreteIndexNames(org.elasticsearch.cluster.ClusterState, org.elasticsearch.action.IndicesRequest). A single comma-separated string is not equivalent: the resolver treats it as one expression.

jobStateIndexPattern

public static String jobStateIndexPattern()

Comma-separated index patterns for ML state indices for REST query strings that split on commas.

Do not pass this value as a single argument to Java client methods that accept one index expression (for example prepareSearch(String)); use jobStateIndexPatterns() instead.

Returns:

index patterns for ML state indices

createStateIndexAndAliasIfNecessary

public static void createStateIndexAndAliasIfNecessary(Client client,
 ProjectMetadata projectMetadata,
 IndexNameExpressionResolver resolver,
 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)

createStateIndexAndAliasIfNecessary

@Deprecated(forRemoval=true)
public static void createStateIndexAndAliasIfNecessary(Client client,
 ClusterState state,
 IndexNameExpressionResolver resolver,
 TimeValue masterNodeTimeout,
 ActionListener<Boolean> finalListener)

Deprecated, for removal: This API element is subject to removal in a future version.

Use createStateIndexAndAliasIfNecessary(Client, ProjectMetadata, IndexNameExpressionResolver, TimeValue, ActionListener)

createStateIndexAndAliasIfNecessaryAndWaitForYellow

public static void createStateIndexAndAliasIfNecessaryAndWaitForYellow(Client client,
 ProjectMetadata projectMetadata,
 IndexNameExpressionResolver resolver,
 TimeValue masterNodeTimeout,
 ActionListener<Boolean> finalListener)

createStateIndexAndAliasIfNecessaryAndWaitForYellow

@Deprecated(forRemoval=true)
public static void createStateIndexAndAliasIfNecessaryAndWaitForYellow(Client client,
 ClusterState state,
 IndexNameExpressionResolver resolver,
 TimeValue masterNodeTimeout,
 ActionListener<Boolean> finalListener)

Deprecated, for removal: This API element is subject to removal in a future version.

Use createStateIndexAndAliasIfNecessaryAndWaitForYellow(Client, ProjectMetadata, IndexNameExpressionResolver, TimeValue, ActionListener)

wrappedResultsMapping

public static String wrappedResultsMapping()

resultsMapping

public static String resultsMapping()