Class Module


  • public final class Module
    extends Object
    Module settings Specifies configuration of a redis module.
    • Constructor Detail

      • Module

        public Module()
    • Method Detail

      • name

        public String name()
        Get the name property: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'.
        Returns:
        the name value.
      • withName

        public Module withName​(String name)
        Set the name property: The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries'.
        Parameters:
        name - the name value to set.
        Returns:
        the Module object itself.
      • args

        public String args()
        Get the args property: Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'.
        Returns:
        the args value.
      • withArgs

        public Module withArgs​(String args)
        Set the args property: Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'.
        Parameters:
        args - the args value to set.
        Returns:
        the Module object itself.
      • version

        public String version()
        Get the version property: The version of the module, e.g. '1.0'.
        Returns:
        the version value.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.