Package org.elasticsearch.cluster.metadata

Class AliasValidator

org.elasticsearch.cluster.metadata.AliasValidator
public class AliasValidator extends
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
     alias,  index,  indexRouting, <,​> lookup)
    Validate a proposed alias.
    void
    validateAlias​(Alias alias,  index, Metadata metadata)
    Allows to validate an Alias and make sure it's valid before it gets added to the index metadata.
    void
     alias,  filter, SearchExecutionContext searchExecutionContext, org.elasticsearch.common.xcontent.NamedXContentRegistry xContentRegistry)
    Validates an alias filter by parsing it using the provided SearchExecutionContext
    void
     alias, BytesReference filter, SearchExecutionContext searchExecutionContext, org.elasticsearch.common.xcontent.NamedXContentRegistry xContentRegistry)
    Validates an alias filter by parsing it using the provided SearchExecutionContext
    void
    validateAliasMetadata​(AliasMetadata aliasMetadata,  index, Metadata metadata)
    Allows to validate an AliasMetadata 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.

    Methods inherited from class java.lang.

    , , , , , , , , , ,

  • Constructor Details

    • AliasValidator

      public AliasValidator()

  • Method Details

    • validateAlias

      public void validateAlias​(Alias alias,  index, Metadata metadata)
      Allows to validate an Alias and make sure it's valid before it gets added to the index metadata. Doesn't validate the alias filter.
      Throws:
      - if the alias is not valid

    • validateAliasMetadata

      public void validateAliasMetadata​(AliasMetadata aliasMetadata,  index, Metadata metadata)
      Allows to validate an AliasMetadata and make sure it's valid before it gets added to the index metadata. Doesn't validate the alias filter.
      Throws:
      - if the alias is not valid

    • validateAliasStandalone

      public void validateAliasStandalone​(Alias alias)
      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 via XContentParser, without validating it as a filter though.
      Throws:
      - if the alias is not valid

    • validateAlias

      public void validateAlias​( alias,  index, @Nullable  indexRouting, <,​> lookup)
      Validate a proposed alias.

    • validateAliasFilter

      public void validateAliasFilter​( alias,  filter, SearchExecutionContext searchExecutionContext, org.elasticsearch.common.xcontent.NamedXContentRegistry xContentRegistry)
      Validates an alias filter by parsing it using the provided SearchExecutionContext
      Throws:
      - if the filter is not valid

    • validateAliasFilter

      public void validateAliasFilter​( alias, BytesReference filter, SearchExecutionContext searchExecutionContext, org.elasticsearch.common.xcontent.NamedXContentRegistry xContentRegistry)
      Validates an alias filter by parsing it using the provided SearchExecutionContext
      Throws:
      - if the filter is not valid