Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.utils

Class MlIndexAndAlias

java.lang.Object

org.elasticsearch.xpack.core.ml.utils.MlIndexAndAlias

public final class MlIndexAndAlias
extends Object

Utils to create an ML index with alias ready for rollover with a 6-digit suffix

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BWC_MAPPINGS_VERSION	ML managed index mappings used to be updated based on the product version.
static final String	FIRST_INDEX_SIX_DIGIT_SUFFIX
static final String	ROLLOVER_ALIAS_SUFFIX

Method Summary

Modifier and Type	Method	Description
static IndicesAliasesRequestBuilder	addResultsIndexRolloverAliasActions(IndicesAliasesRequestBuilder aliasRequestBuilder, String newIndex, ClusterState clusterState, List<String> currentJobResultsIndices)	Deprecated, for removal: This API element is subject to removal in a future version. Use addResultsIndexRolloverAliasActions(IndicesAliasesRequestBuilder, String, ProjectMetadata, List)
static IndicesAliasesRequestBuilder	addResultsIndexRolloverAliasActions(IndicesAliasesRequestBuilder aliasRequestBuilder, String newIndex, ProjectMetadata projectMetadata, List<String> currentJobResultsIndices)	Adds alias actions to a request builder to move ML job aliases from an old index to a new one after a rollover.
static IndicesAliasesRequestBuilder	addStateIndexRolloverAliasActions(IndicesAliasesRequestBuilder aliasRequestBuilder, String newIndex, ClusterState clusterState, List<String> allStateIndices)	Deprecated, for removal: This API element is subject to removal in a future version. Use addStateIndexRolloverAliasActions(IndicesAliasesRequestBuilder, String, ProjectMetadata, List)
static IndicesAliasesRequestBuilder	addStateIndexRolloverAliasActions(IndicesAliasesRequestBuilder aliasRequestBuilder, String newIndex, ProjectMetadata projectMetadata, List<String> allStateIndices)	Adds alias actions to a request builder to move the ML state write alias from an old index to a new one after a rollover.
static String	baseIndexName(String index)	Returns the given index name without its 6 digit suffix.
static void	createAliasForRollover(Client client, String indexName, String aliasName, ActionListener<IndicesAliasesResponse> listener)	Creates a hidden alias for an index, typically used as a rollover target.
static void	createIndexAndAliasIfNecessary(Client client, ClusterState clusterState, IndexNameExpressionResolver resolver, String indexPatternPrefix, String indexNumber, String alias, TimeValue masterNodeTimeout, ActiveShardCount waitForShardCount, ActionListener<Boolean> finalListener)	Deprecated, for removal: This API element is subject to removal in a future version. Use createIndexAndAliasIfNecessary(Client, ProjectMetadata, IndexNameExpressionResolver, String, String, String, TimeValue, ActiveShardCount, ActionListener)
static void	createIndexAndAliasIfNecessary(Client client, ClusterState clusterState, IndexNameExpressionResolver resolver, String indexPatternPrefix, String alias, TimeValue masterNodeTimeout, ActiveShardCount waitForShardCount, ActionListener<Boolean> finalListener)	Deprecated, for removal: This API element is subject to removal in a future version. Use createIndexAndAliasIfNecessary(Client, ProjectMetadata, IndexNameExpressionResolver, String, String, TimeValue, ActiveShardCount, ActionListener)
static void	createIndexAndAliasIfNecessary(Client client, ProjectMetadata projectMetadata, IndexNameExpressionResolver resolver, String indexPatternPrefix, String indexNumber, String alias, TimeValue masterNodeTimeout, ActiveShardCount waitForShardCount, ActionListener<Boolean> finalListener)	Same as createIndexAndAliasIfNecessary but with the first concrete index number specified.
static void	createIndexAndAliasIfNecessary(Client client, ProjectMetadata projectMetadata, IndexNameExpressionResolver resolver, String indexPatternPrefix, String alias, TimeValue masterNodeTimeout, ActiveShardCount waitForShardCount, ActionListener<Boolean> finalListener)	Creates the first index with a name of the given indexPatternPrefix followed by "-000001", if the index is missing.
static IndicesAliasesRequestBuilder	createIndicesAliasesRequestBuilder(Client client)	Creates a pre-configured IndicesAliasesRequestBuilder with default timeouts.
static Tuple<String,String>	createRolloverAliasAndNewIndexName(String index)	Generates a temporary rollover alias and a potential new index name based on a source index name.
static void	createSystemIndexIfNecessary(Client client, ClusterState clusterState, SystemIndexDescriptor descriptor, TimeValue masterNodeTimeout, ActionListener<Boolean> finalListener)	Deprecated, for removal: This API element is subject to removal in a future version. Use createSystemIndexIfNecessary(Client, ProjectMetadata, SystemIndexDescriptor, TimeValue, ActionListener)
static void	createSystemIndexIfNecessary(Client client, ProjectMetadata projectMetadata, SystemIndexDescriptor descriptor, TimeValue masterNodeTimeout, ActionListener<Boolean> finalListener)	Creates a system index based on the provided descriptor if it does not already exist.
static String	ensureValidResultsIndexName(String indexName)	Ensures a given index name is valid for ML results by appending the 6-digit suffix if it is missing.
static boolean	has6DigitSuffix(String indexName)	Checks if an index name ends with a 6-digit suffix (e.g., "-000001").
static boolean	hasFieldTypedAs(IndexMetadata indexMetadata, String fieldName, String expectedType)	Returns true if the top-level mapping of indexMetadata contains a field named fieldName whose "type" attribute equals expectedType.
static boolean	indexIsReadWriteCompatibleInV9(IndexVersion version)	True if the version is read *and* write compatible not just read only compatible
static String[]	indicesMatchingBasename(String baseIndexName, IndexNameExpressionResolver expressionResolver, ClusterState latestState)	Deprecated, for removal: This API element is subject to removal in a future version. Use indicesMatchingBasename(String, IndexNameExpressionResolver, ProjectMetadata)
static String[]	indicesMatchingBasename(String baseIndexName, IndexNameExpressionResolver expressionResolver, ProjectMetadata projectMetadata)	Returns an array of indices that match the given base index name.
static void	installIndexTemplateIfRequired(ClusterState clusterState, Client client, int templateVersion, TransportPutComposableIndexTemplateAction.Request templateRequest, ActionListener<Boolean> listener)	Deprecated, for removal: This API element is subject to removal in a future version. Use installIndexTemplateIfRequired(ProjectMetadata, Client, int, TransportPutComposableIndexTemplateAction.Request, ActionListener)
static void	installIndexTemplateIfRequired(ClusterState clusterState, Client client, IndexTemplateConfig templateConfig, TimeValue masterTimeout, ActionListener<Boolean> listener)	Deprecated, for removal: This API element is subject to removal in a future version. Use installIndexTemplateIfRequired(ProjectMetadata, Client, IndexTemplateConfig, TimeValue, ActionListener)
static void	installIndexTemplateIfRequired(ProjectMetadata projectMetadata, Client client, int templateVersion, TransportPutComposableIndexTemplateAction.Request templateRequest, ActionListener<Boolean> listener)	See installIndexTemplateIfRequired(ProjectMetadata, Client, IndexTemplateConfig, TimeValue, ActionListener).
static void	installIndexTemplateIfRequired(ProjectMetadata projectMetadata, Client client, IndexTemplateConfig templateConfig, TimeValue masterTimeout, ActionListener<Boolean> listener)	Installs the index template specified by templateConfig if it is not already installed in projectMetadata.
static boolean	isAnomaliesReadAlias(String aliasName)	Determines if an alias name is an ML anomalies read alias.
static boolean	isAnomaliesSharedIndex(String indexName)	Checks if an index name matches the pattern for the default ML anomalies indices (e.g., ".ml-anomalies-shared-000001").
static boolean	isAnomaliesStateIndex(String indexName)	Checks if an index name matches the pattern for ML anomalies state indices (for example .ml-state-000001 or .reindexed-v8-ml-state-000001).
static boolean	isAnomaliesWriteAlias(String aliasName)	Determines if an alias name is an ML anomalies write alias.
static String	latestIndex(String[] concreteIndices)	Returns the latest index.
static String	latestIndexMatchingBaseName(String index, IndexNameExpressionResolver expressionResolver, ClusterState latestState)	Deprecated, for removal: This API element is subject to removal in a future version. Use latestIndexMatchingBaseName(String, IndexNameExpressionResolver, ProjectMetadata)
static String	latestIndexMatchingBaseName(String index, IndexNameExpressionResolver expressionResolver, ProjectMetadata projectMetadata)	Strip any suffix from the index name and find any other indices that match the base name.
static int	nextSuffix(String[] exactFamily)	Returns the lowest suffix integer (≥ 1) not yet occupied by any member of exactFamily.
static void	rollover(Client client, RolloverRequest rolloverRequest, ActionListener<String> listener)	Executes a rollover request.
static void	sortIndices(List<String> indices)	Sorts the given list of indices based on their 6 digit suffix.
static String[]	strictFamily(String baseIndexName, String[] candidates)	Filters candidates to only those exactly matching baseIndexName-NNNNNN.
static String[]	strictFamilyOf(String baseIndexName, IndexNameExpressionResolver expressionResolver, ClusterState state)	Convenience method combining indicesMatchingBasename(java.lang.String, org.elasticsearch.cluster.metadata.IndexNameExpressionResolver, org.elasticsearch.cluster.metadata.ProjectMetadata) and strictFamily(java.lang.String, java.lang.String[]): resolves all cluster indices that match baseIndexName + "*" and then filters to the exact family (i.e.
static void	updateAliases(IndicesAliasesRequestBuilder request, ActionListener<Boolean> listener)	Executes a prepared IndicesAliasesRequestBuilder and notifies the listener of the result.
static void	updateWriteAlias(Client client, String alias, String currentIndex, String newIndex, TimeValue masterNodeTimeout, ActionListener<Boolean> listener)	Creates or moves a write alias from one index to another.

Methods inherited from class java.lang.Object

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

Field Details

BWC_MAPPINGS_VERSION

public static final String BWC_MAPPINGS_VERSION

ML managed index mappings used to be updated based on the product version. They are now updated based on per-index mappings versions. However, older nodes will still look for a product version in the mappings metadata, so we have to put something in that field that will allow the older node to realise that the mappings are ahead of what it knows about. The easiest solution is to hardcode 8.11.0 in this field, because any node from 8.10.0 onwards should be using per-index mappings versions to determine whether mappings are up-to-date.

See Also:

• Constant Field Values

FIRST_INDEX_SIX_DIGIT_SUFFIX

public static final String FIRST_INDEX_SIX_DIGIT_SUFFIX

See Also:

• Constant Field Values

ROLLOVER_ALIAS_SUFFIX

public static final String ROLLOVER_ALIAS_SUFFIX

See Also:

• Constant Field Values

Method Details

createIndexAndAliasIfNecessary

public static void createIndexAndAliasIfNecessary(Client client,
 ProjectMetadata projectMetadata,
 IndexNameExpressionResolver resolver,
 String indexPatternPrefix,
 String alias,
 TimeValue masterNodeTimeout,
 ActiveShardCount waitForShardCount,
 ActionListener<Boolean> finalListener)

Creates the first index with a name of the given indexPatternPrefix followed by "-000001", if the index is missing. Adds an alias to that index if it was created, or to the index with the highest suffix if the index did not have to be created. The listener is notified with a boolean that informs whether the index or the alias were created. If the index is created, the listener is not called until the index is ready to use via the supplied alias, so that a method that receives a success response from this method can safely use the index immediately.

createIndexAndAliasIfNecessary

@Deprecated(forRemoval=true)
public static void createIndexAndAliasIfNecessary(Client client,
 ClusterState clusterState,
 IndexNameExpressionResolver resolver,
 String indexPatternPrefix,
 String alias,
 TimeValue masterNodeTimeout,
 ActiveShardCount waitForShardCount,
 ActionListener<Boolean> finalListener)

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

Use createIndexAndAliasIfNecessary(Client, ProjectMetadata, IndexNameExpressionResolver, String, String, TimeValue, ActiveShardCount, ActionListener)

createIndexAndAliasIfNecessary

public static void createIndexAndAliasIfNecessary(Client client,
 ProjectMetadata projectMetadata,
 IndexNameExpressionResolver resolver,
 String indexPatternPrefix,
 String indexNumber,
 String alias,
 TimeValue masterNodeTimeout,
 ActiveShardCount waitForShardCount,
 ActionListener<Boolean> finalListener)

Same as createIndexAndAliasIfNecessary but with the first concrete index number specified.

createIndexAndAliasIfNecessary

@Deprecated(forRemoval=true)
public static void createIndexAndAliasIfNecessary(Client client,
 ClusterState clusterState,
 IndexNameExpressionResolver resolver,
 String indexPatternPrefix,
 String indexNumber,
 String alias,
 TimeValue masterNodeTimeout,
 ActiveShardCount waitForShardCount,
 ActionListener<Boolean> finalListener)

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

Use createIndexAndAliasIfNecessary(Client, ProjectMetadata, IndexNameExpressionResolver, String, String, String, TimeValue, ActiveShardCount, ActionListener)

createSystemIndexIfNecessary

public static void createSystemIndexIfNecessary(Client client,
 ProjectMetadata projectMetadata,
 SystemIndexDescriptor descriptor,
 TimeValue masterNodeTimeout,
 ActionListener<Boolean> finalListener)

Creates a system index based on the provided descriptor if it does not already exist.

The check for existence is simple and will return the listener on the calling thread if successful. If the index needs to be created an async call will be made and this method will wait for the index to reach at least a yellow health status before notifying the listener, ensuring it is ready for use upon a successful response. A ResourceAlreadyExistsException during creation is handled gracefully and treated as a success.

Parameters:

client - The client to use for the create index request.

projectMetadata - The current project metadata, used for the initial existence check.

descriptor - The descriptor containing the index name, settings, and mappings.

masterNodeTimeout - The timeout for waiting on the master node.

finalListener - Async listener

createSystemIndexIfNecessary

@Deprecated(forRemoval=true)
public static void createSystemIndexIfNecessary(Client client,
 ClusterState clusterState,
 SystemIndexDescriptor descriptor,
 TimeValue masterNodeTimeout,
 ActionListener<Boolean> finalListener)

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

Use createSystemIndexIfNecessary(Client, ProjectMetadata, SystemIndexDescriptor, TimeValue, ActionListener)

updateWriteAlias

public static void updateWriteAlias(Client client,
 String alias,
 @Nullable
 String currentIndex,
 String newIndex,
 TimeValue masterNodeTimeout,
 ActionListener<Boolean> listener)

Creates or moves a write alias from one index to another.

Parameters:

client - The client to use for the add alias request.

alias - The alias to update.

currentIndex - The index the alias is currently pointing to.

newIndex - The new index the alias should point to.

masterNodeTimeout - The timeout for waiting on the master node.

listener - Async listener

installIndexTemplateIfRequired

public static void installIndexTemplateIfRequired(ProjectMetadata projectMetadata,
 Client client,
 IndexTemplateConfig templateConfig,
 TimeValue masterTimeout,
 ActionListener<Boolean> listener)

Installs the index template specified by templateConfig if it is not already installed in projectMetadata.

The check for presence is simple and will return the listener on the calling thread if successful. If the template has to be installed an async call will be made.

Parameters:

projectMetadata - The project metadata to check for template existence

client - For putting the template

templateConfig - The config

listener - Async listener

installIndexTemplateIfRequired

@Deprecated(forRemoval=true)
public static void installIndexTemplateIfRequired(ClusterState clusterState,
 Client client,
 IndexTemplateConfig templateConfig,
 TimeValue masterTimeout,
 ActionListener<Boolean> listener)

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

Use installIndexTemplateIfRequired(ProjectMetadata, Client, IndexTemplateConfig, TimeValue, ActionListener)

installIndexTemplateIfRequired

public static void installIndexTemplateIfRequired(ProjectMetadata projectMetadata,
 Client client,
 int templateVersion,
 TransportPutComposableIndexTemplateAction.Request templateRequest,
 ActionListener<Boolean> listener)

See installIndexTemplateIfRequired(ProjectMetadata, Client, IndexTemplateConfig, TimeValue, ActionListener). Overload takes a PutIndexTemplateRequest instead of IndexTemplateConfig.

Parameters:

projectMetadata - The project metadata to check for template existence

client - For putting the template

templateRequest - The Put template request

listener - Async listener

installIndexTemplateIfRequired

@Deprecated(forRemoval=true)
public static void installIndexTemplateIfRequired(ClusterState clusterState,
 Client client,
 int templateVersion,
 TransportPutComposableIndexTemplateAction.Request templateRequest,
 ActionListener<Boolean> listener)

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

Use installIndexTemplateIfRequired(ProjectMetadata, Client, int, TransportPutComposableIndexTemplateAction.Request, ActionListener)

ensureValidResultsIndexName

public static String ensureValidResultsIndexName(String indexName)

Ensures a given index name is valid for ML results by appending the 6-digit suffix if it is missing.

Parameters:

indexName - The index name to validate.

Returns:

The validated index name, with the suffix added if it was missing.

has6DigitSuffix

public static boolean has6DigitSuffix(String indexName)

Checks if an index name ends with a 6-digit suffix (e.g., "-000001").

Parameters:

indexName - The name of the index to check.

Returns:

true if the index name has a 6-digit suffix, false otherwise.

isAnomaliesSharedIndex

public static boolean isAnomaliesSharedIndex(String indexName)

Checks if an index name matches the pattern for the default ML anomalies indices (e.g., ".ml-anomalies-shared-000001").

Parameters:

indexName - The name of the index to check.

Returns:

true if the index is a shared anomalies index, false otherwise.

isAnomaliesStateIndex

public static boolean isAnomaliesStateIndex(String indexName)

Checks if an index name matches the pattern for ML anomalies state indices (for example .ml-state-000001 or .reindexed-v8-ml-state-000001).

Parameters:

indexName - The name of the index to check.

Returns:

true if the index is an anomalies state index, false otherwise.

latestIndex

public static String latestIndex(String[] concreteIndices)

Returns the latest index. Latest is the index with the highest 6 digit suffix.

Parameters:

concreteIndices - List of index names

Returns:

The latest index by index name version suffix

sortIndices

public static void sortIndices(List<String> indices)

Sorts the given list of indices based on their 6 digit suffix.

Parameters:

indices - List of index names

indexIsReadWriteCompatibleInV9

public static boolean indexIsReadWriteCompatibleInV9(IndexVersion version)

True if the version is read *and* write compatible not just read only compatible

baseIndexName

public static String baseIndexName(String index)

Returns the given index name without its 6 digit suffix.

Parameters:

index - The index name to check

Returns:

The base index name, without the 6 digit suffix.

indicesMatchingBasename

public static String[] indicesMatchingBasename(String baseIndexName,
 IndexNameExpressionResolver expressionResolver,
 ProjectMetadata projectMetadata)

Returns an array of indices that match the given base index name.

Parameters:

baseIndexName - The base part of an index name, without the 6 digit suffix.

expressionResolver - The expression resolver

projectMetadata - The project metadata to resolve indices against

Returns:

An array of matching indices.

indicesMatchingBasename

@Deprecated(forRemoval=true)
public static String[] indicesMatchingBasename(String baseIndexName,
 IndexNameExpressionResolver expressionResolver,
 ClusterState latestState)

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

Use indicesMatchingBasename(String, IndexNameExpressionResolver, ProjectMetadata)

strictFamily

public static String[] strictFamily(String baseIndexName,
 String[] candidates)

Filters candidates to only those exactly matching baseIndexName-NNNNNN. Complements indicesMatchingBasename(java.lang.String, org.elasticsearch.cluster.metadata.IndexNameExpressionResolver, org.elasticsearch.cluster.metadata.ProjectMetadata) by excluding indices that just share the prefix. Use when dealing with rollover generations to avoid matching unrelated indices.

Parameters:

baseIndexName - The base part of an index name, without the 6 digit suffix.

candidates - The candidate index names to filter (typically the result of indicesMatchingBasename(java.lang.String, org.elasticsearch.cluster.metadata.IndexNameExpressionResolver, org.elasticsearch.cluster.metadata.ProjectMetadata)).

Returns:

The subset of candidates that belong to exactly this family.

strictFamilyOf

public static String[] strictFamilyOf(String baseIndexName,
 IndexNameExpressionResolver expressionResolver,
 ClusterState state)

Convenience method combining indicesMatchingBasename(java.lang.String, org.elasticsearch.cluster.metadata.IndexNameExpressionResolver, org.elasticsearch.cluster.metadata.ProjectMetadata) and strictFamily(java.lang.String, java.lang.String[]): resolves all cluster indices that match baseIndexName + "*" and then filters to the exact family (i.e. exactly baseIndexName-NNNNNN names).

Parameters:

baseIndexName - The base part of an index name, without the 6 digit suffix.

expressionResolver - The expression resolver.

state - The cluster state.

Returns:

The exact rollover family for baseIndexName.

nextSuffix

public static int nextSuffix(String[] exactFamily)

Returns the lowest suffix integer (≥ 1) not yet occupied by any member of exactFamily. If exactFamily is empty, returns 1, which will produce the first base-000001 index.

Only family members with a parseable numeric 6-digit suffix are considered; anything else is silently skipped.

Parameters:

exactFamily - The strict (length-exact) rollover family array, as returned by strictFamily(java.lang.String, java.lang.String[]) or strictFamilyOf(java.lang.String, org.elasticsearch.cluster.metadata.IndexNameExpressionResolver, org.elasticsearch.cluster.ClusterState).

Returns:

The next free suffix integer.

hasFieldTypedAs

public static boolean hasFieldTypedAs(IndexMetadata indexMetadata,
 String fieldName,
 String expectedType)

Returns true if the top-level mapping of indexMetadata contains a field named fieldName whose "type" attribute equals expectedType.

Returns false for absent metadata, missing mappings, missing properties block, missing field, or non-matching type — i.e. all failure modes are collapsed to false so callers do not need defensive null-checks.

Parameters:

indexMetadata - The index metadata to inspect. May be null.

fieldName - The field to look up inside the top-level properties block.

expectedType - The expected Elasticsearch field type string (e.g. "keyword").

Returns:

true iff the field exists and has the expected type.

latestIndexMatchingBaseName

public static String latestIndexMatchingBaseName(String index,
 IndexNameExpressionResolver expressionResolver,
 ProjectMetadata projectMetadata)

Strip any suffix from the index name and find any other indices that match the base name. Then return the latest index from the matching ones.

Parameters:

index - The index to check

expressionResolver - The expression resolver

projectMetadata - The project metadata to resolve indices against

Returns:

The latest index that matches the base name of the given index

latestIndexMatchingBaseName

@Deprecated(forRemoval=true)
public static String latestIndexMatchingBaseName(String index,
 IndexNameExpressionResolver expressionResolver,
 ClusterState latestState)

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

Use latestIndexMatchingBaseName(String, IndexNameExpressionResolver, ProjectMetadata)

rollover

public static void rollover(Client client,
 RolloverRequest rolloverRequest,
 ActionListener<String> listener)

Executes a rollover request. It handles ResourceAlreadyExistsException gracefully by treating it as a success and returning the name of the existing index.

Parameters:

client - The client to use for the rollover request.

rolloverRequest - The rollover request to execute.

listener - A listener that will be notified with the name of the new (or pre-existing) index on success, or an exception on failure.

createRolloverAliasAndNewIndexName

public static Tuple<String,String> createRolloverAliasAndNewIndexName(String index)

Generates a temporary rollover alias and a potential new index name based on a source index name. This is a preparatory step for a rollover action. If the source index already has a 6-digit suffix, the new index name will be null, allowing the rollover API to auto-increment the suffix.

Parameters:

index - The name of the index that is a candidate for rollover.

Returns:

A Tuple where v1 is the generated rollover alias and v2 is the new index name (or null if rollover can auto-determine it).

createIndicesAliasesRequestBuilder

public static IndicesAliasesRequestBuilder createIndicesAliasesRequestBuilder(Client client)

Creates a pre-configured IndicesAliasesRequestBuilder with default timeouts.

Parameters:

client - The client to use for the request.

Returns:

A new IndicesAliasesRequestBuilder.

createAliasForRollover

public static void createAliasForRollover(Client client,
 String indexName,
 String aliasName,
 ActionListener<IndicesAliasesResponse> listener)

Creates a hidden alias for an index, typically used as a rollover target.

Parameters:

client - The client to use for the alias request.

indexName - The name of the index to which the alias will be added.

aliasName - The name of the alias to create.

listener - A listener that will be notified with the response.

updateAliases

public static void updateAliases(IndicesAliasesRequestBuilder request,
 ActionListener<Boolean> listener)

Executes a prepared IndicesAliasesRequestBuilder and notifies the listener of the result.

Parameters:

request - The prepared request builder containing alias actions.

listener - A listener that will be notified with true on success.

addStateIndexRolloverAliasActions

public static IndicesAliasesRequestBuilder addStateIndexRolloverAliasActions(IndicesAliasesRequestBuilder aliasRequestBuilder,
 String newIndex,
 ProjectMetadata projectMetadata,
 List<String> allStateIndices)

Adds alias actions to a request builder to move the ML state write alias from an old index to a new one after a rollover. This method is robust and will move the correct alias regardless of the current alias state on the old index.

Parameters:

aliasRequestBuilder - The request builder to add actions to.

newIndex - The new index to which the alias will be moved.

projectMetadata - The current project metadata, used to inspect existing indices.

allStateIndices - A list of all current .ml-state indices

Returns:

The modified IndicesAliasesRequestBuilder.

addStateIndexRolloverAliasActions

@Deprecated(forRemoval=true)
public static IndicesAliasesRequestBuilder addStateIndexRolloverAliasActions(IndicesAliasesRequestBuilder aliasRequestBuilder,
 String newIndex,
 ClusterState clusterState,
 List<String> allStateIndices)

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

Use addStateIndexRolloverAliasActions(IndicesAliasesRequestBuilder, String, ProjectMetadata, List)

addResultsIndexRolloverAliasActions

public static IndicesAliasesRequestBuilder addResultsIndexRolloverAliasActions(IndicesAliasesRequestBuilder aliasRequestBuilder,
 String newIndex,
 ProjectMetadata projectMetadata,
 List<String> currentJobResultsIndices)

Adds alias actions to a request builder to move ML job aliases from an old index to a new one after a rollover. This includes moving the write alias and re-creating the filtered read aliases on the new index.

Parameters:

aliasRequestBuilder - The request builder to add actions to.

newIndex - The new index to which aliases will be moved.

projectMetadata - The project metadata to resolve indices against

currentJobResultsIndices - A list of all current .ml-anomalies indices

Returns:

The modified IndicesAliasesRequestBuilder.

addResultsIndexRolloverAliasActions

@Deprecated(forRemoval=true)
public static IndicesAliasesRequestBuilder addResultsIndexRolloverAliasActions(IndicesAliasesRequestBuilder aliasRequestBuilder,
 String newIndex,
 ClusterState clusterState,
 List<String> currentJobResultsIndices)

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

Use addResultsIndexRolloverAliasActions(IndicesAliasesRequestBuilder, String, ProjectMetadata, List)

isAnomaliesWriteAlias

public static boolean isAnomaliesWriteAlias(String aliasName)

Determines if an alias name is an ML anomalies write alias.

Parameters:

aliasName - The alias name to check.

Returns:

true if the name matches the write alias pattern, false otherwise.

isAnomaliesReadAlias

public static boolean isAnomaliesReadAlias(String aliasName)

Determines if an alias name is an ML anomalies read alias.

Parameters:

aliasName - The alias name to check.

Returns:

true if the name matches the read alias pattern, false otherwise.