Class AliasValidator
java.lang.Object
org.elasticsearch.cluster.metadata.AliasValidator
public class AliasValidator
extends java.lang.Object
Validator for an alias, to be used before adding an alias to the index metadata
and make sure the alias is valid
-
Constructor Summary
Constructors Constructor Description AliasValidator()
-
Method Summary
Modifier and Type Method Description void
validateAlias(java.lang.String alias, java.lang.String index, java.lang.String indexRouting, java.util.function.Function<java.lang.String,IndexMetadata> indexLookup)
Validate a proposed alias.void
validateAlias(Alias alias, java.lang.String index, Metadata metadata)
Allows to validate anAlias
and make sure it's valid before it gets added to the index metadata.void
validateAliasFilter(java.lang.String alias, byte[] filter, QueryShardContext queryShardContext, NamedXContentRegistry xContentRegistry)
Validates an alias filter by parsing it using the providedQueryShardContext
void
validateAliasFilter(java.lang.String alias, java.lang.String filter, QueryShardContext queryShardContext, NamedXContentRegistry xContentRegistry)
Validates an alias filter by parsing it using the providedQueryShardContext
void
validateAliasMetadata(AliasMetadata aliasMetadata, java.lang.String index, Metadata metadata)
Allows to validate anAliasMetadata
and make sure it's valid before it gets added to the index metadata.void
validateAliasStandalone(Alias alias)
Allows to partially validate an alias, without knowing which index it'll get applied to.
-
Constructor Details
-
AliasValidator
public AliasValidator()
-
-
Method Details
-
validateAlias
Allows to validate anAlias
and make sure it's valid before it gets added to the index metadata. Doesn't validate the alias filter.- Throws:
java.lang.IllegalArgumentException
- if the alias is not valid
-
validateAliasMetadata
public void validateAliasMetadata(AliasMetadata aliasMetadata, java.lang.String index, Metadata metadata)Allows to validate anAliasMetadata
and make sure it's valid before it gets added to the index metadata. Doesn't validate the alias filter.- Throws:
java.lang.IllegalArgumentException
- if the alias is not valid
-
validateAliasStandalone
Allows to partially validate an alias, without knowing which index it'll get applied to. Useful with index templates containing aliases. Checks also that it is possible to parse the alias filter viaXContentParser
, without validating it as a filter though.- Throws:
java.lang.IllegalArgumentException
- if the alias is not valid
-
validateAlias
public void validateAlias(java.lang.String alias, java.lang.String index, @Nullable java.lang.String indexRouting, java.util.function.Function<java.lang.String,IndexMetadata> indexLookup)Validate a proposed alias. -
validateAliasFilter
public void validateAliasFilter(java.lang.String alias, java.lang.String filter, QueryShardContext queryShardContext, NamedXContentRegistry xContentRegistry)Validates an alias filter by parsing it using the providedQueryShardContext
- Throws:
java.lang.IllegalArgumentException
- if the filter is not valid
-
validateAliasFilter
public void validateAliasFilter(java.lang.String alias, byte[] filter, QueryShardContext queryShardContext, NamedXContentRegistry xContentRegistry)Validates an alias filter by parsing it using the providedQueryShardContext
- Throws:
java.lang.IllegalArgumentException
- if the filter is not valid
-