Class JoinConfigCompatCheckSharding

java.lang.Object
org.apache.pekko.cluster.JoinConfigCompatChecker
org.apache.pekko.cluster.sharding.JoinConfigCompatCheckSharding

public final class JoinConfigCompatCheckSharding extends JoinConfigCompatChecker
INTERNAL API
  • Constructor Details

    • JoinConfigCompatCheckSharding

      public JoinConfigCompatCheckSharding()
  • Method Details

    • check

      public ConfigValidation check(com.typesafe.config.Config toCheck, com.typesafe.config.Config actualConfig)
      Description copied from class: JoinConfigCompatChecker
      Runs the Config check.

      Implementers are free to define what makes Config entry compatible or not. We do provide some pre-build checks tough: JoinConfigCompatChecker.exists and JoinConfigCompatChecker.fullMatch

      Specified by:
      check in class JoinConfigCompatChecker
      Parameters:
      toCheck - - the Config instance to be checked
      actualConfig - - the Config instance containing the actual values
      Returns:
      a ConfigValidation. Can be Valid or Invalid, the later must contain a descriptive list of error messages.
    • requiredKeys

      public scala.collection.immutable.Seq<String> requiredKeys()
      Description copied from class: JoinConfigCompatChecker
      The configuration keys that are required for this checker
      Specified by:
      requiredKeys in class JoinConfigCompatChecker