java.lang.Object
org.elasticsearch.cluster.metadata.AliasValidator
Validator for an alias, to be used before adding an alias to the index metadata
and make sure the alias is valid
-
Method Summary
Modifier and TypeMethodDescriptionstatic voidValidate a proposed alias.static voidvalidateAlias(Alias alias, String index, Metadata metadata) Allows to validate anAliasand make sure it's valid before it gets added to the index metadata.static voidvalidateAliasFilter(String alias, String filter, SearchExecutionContext searchExecutionContext, NamedXContentRegistry xContentRegistry) Validates an alias filter by parsing it using the providedSearchExecutionContextstatic voidvalidateAliasFilter(String alias, BytesReference filter, SearchExecutionContext searchExecutionContext, NamedXContentRegistry xContentRegistry) Validates an alias filter by parsing it using the providedSearchExecutionContextstatic voidvalidateAliasMetadata(AliasMetadata aliasMetadata, String index, Metadata metadata) Allows to validate anAliasMetadataand make sure it's valid before it gets added to the index metadata.static voidvalidateAliasStandalone(Alias alias) Allows to partially validate an alias, without knowing which index it'll get applied to.
-
Method Details
-
validateAlias
Allows to validate anAliasand make sure it's valid before it gets added to the index metadata. Doesn't validate the alias filter.- Throws:
IllegalArgumentException- if the alias is not valid
-
validateAliasMetadata
public static void validateAliasMetadata(AliasMetadata aliasMetadata, String index, Metadata metadata) Allows to validate anAliasMetadataand make sure it's valid before it gets added to the index metadata. Doesn't validate the alias filter.- Throws:
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:
IllegalArgumentException- if the alias is not valid
-
validateAlias
public static void validateAlias(String alias, String index, @Nullable String indexRouting, Function<String, String> lookup) Validate a proposed alias. -
validateAliasFilter
public static void validateAliasFilter(String alias, String filter, SearchExecutionContext searchExecutionContext, NamedXContentRegistry xContentRegistry) Validates an alias filter by parsing it using the providedSearchExecutionContext- Throws:
IllegalArgumentException- if the filter is not valid
-
validateAliasFilter
public static void validateAliasFilter(String alias, BytesReference filter, SearchExecutionContext searchExecutionContext, NamedXContentRegistry xContentRegistry) Validates an alias filter by parsing it using the providedSearchExecutionContext- Throws:
IllegalArgumentException- if the filter is not valid
-