Enum Class ValkeyConfigurations

java.lang.Object
java.lang.Enum<ValkeyConfigurations>
org.eclipse.jnosql.databases.valkey.communication.ValkeyConfigurations
All Implemented Interfaces:
Serializable, Comparable<ValkeyConfigurations>, Constable, Supplier<String>

public enum ValkeyConfigurations extends Enum<ValkeyConfigurations> implements Supplier<String>
An enumeration to show the available options to connect to the Redis database. It implements Supplier, where its it returns the property name that might be overwritten by the system environment using Eclipse Microprofile or Jakarta Config API.
See Also:
  • Settings
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
     

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    The cluster client's name.
    The value for the clientset info disabled configuration attribute for the jedis client configuration with this configuration instance.
    The value for the clientset info configuration libname suffix attribute for the jedis client configuration with this configuration instance.
    The value for the connection timeout in milliseconds configuration attribute for the jedis client configuration created with this configuration instance.
    The redis database number
    The database host
    The value for the maxIdle configuration attribute for pools created with this configuration instance.
    The value for the maxTotal configuration attribute for pools created with this configuration instance.
    The value for the maxWait configuration attribute for pools created with this configuration instance.
    The value for the minIdle configuration attribute for pools created with this configuration instance.
    The password's credential
    The database port
    The value for the protocol configuration attribute for the jedis client configuration with this configuration instance.
    The value for the socket timeout in milliseconds configuration attribute for the jedis client configuration with this configuration instance.
    The value for the ssl configuration attribute for the jedis client configuration with this configuration instance.
    The redis timeout, the default value is Protocol.DEFAULT_TIMEOUT on milliseconds
    The value for the user configuration attribute for the jedis client configuration with this configuration instance.
  • Method Summary

    Modifier and Type
    Method
    Description
    get()
     
    Returns the enum constant of this class with the specified name.
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • HOST

      public static final ValkeyConfigurations HOST
      The database host
    • PORT

      public static final ValkeyConfigurations PORT
      The database port
    • TIMEOUT

      public static final ValkeyConfigurations TIMEOUT
      The redis timeout, the default value is Protocol.DEFAULT_TIMEOUT on milliseconds
    • PASSWORD

      public static final ValkeyConfigurations PASSWORD
      The password's credential
    • DATABASE

      public static final ValkeyConfigurations DATABASE
      The redis database number
    • CLIENT_NAME

      public static final ValkeyConfigurations CLIENT_NAME
      The cluster client's name. The default value is 0.
    • MAX_TOTAL

      public static final ValkeyConfigurations MAX_TOTAL
      The value for the maxTotal configuration attribute for pools created with this configuration instance. The default value is GenericObjectPoolConfig.DEFAULT_MAX_TOTAL
    • MAX_IDLE

      public static final ValkeyConfigurations MAX_IDLE
      The value for the maxIdle configuration attribute for pools created with this configuration instance. The default value is GenericObjectPoolConfig.DEFAULT_MAX_IDLE
    • MIN_IDLE

      public static final ValkeyConfigurations MIN_IDLE
      The value for the minIdle configuration attribute for pools created with this configuration instance. The default value is GenericObjectPoolConfig.DEFAULT_MIN_IDLE
    • MAX_WAIT_MILLIS

      public static final ValkeyConfigurations MAX_WAIT_MILLIS
      The value for the maxWait configuration attribute for pools created with this configuration instance. The default value is BaseObjectPoolConfig.DEFAULT_MAX_WAIT_MILLIS
    • CONNECTION_TIMEOUT

      public static final ValkeyConfigurations CONNECTION_TIMEOUT
      The value for the connection timeout in milliseconds configuration attribute for the jedis client configuration created with this configuration instance. The connection timeout on millis on JedisClientConfig, the default value is Protocol.DEFAULT_TIMEOUT
    • SOCKET_TIMEOUT

      public static final ValkeyConfigurations SOCKET_TIMEOUT
      The value for the socket timeout in milliseconds configuration attribute for the jedis client configuration with this configuration instance. The socket timeout on millis on JedisClientConfig, the default value is Protocol.DEFAULT_TIMEOUT
    • USER

      public static final ValkeyConfigurations USER
      The value for the user configuration attribute for the jedis client configuration with this configuration instance. The user on JedisClientConfig
    • SSL

      public static final ValkeyConfigurations SSL
      The value for the ssl configuration attribute for the jedis client configuration with this configuration instance. The ssl on JedisClientConfig. The default value is false.
    • REDIS_PROTOCOL

      public static final ValkeyConfigurations REDIS_PROTOCOL
      The value for the protocol configuration attribute for the jedis client configuration with this configuration instance. The protocol on JedisClientConfig. The default value is not defined.
    • CLIENTSET_INFO_CONFIG_DISABLED

      public static final ValkeyConfigurations CLIENTSET_INFO_CONFIG_DISABLED
      The value for the clientset info disabled configuration attribute for the jedis client configuration with this configuration instance. The clientset info disabled on JedisClientConfig. The default value is false.
    • CLIENTSET_INFO_CONFIG_LIBNAME_SUFFIX

      public static final ValkeyConfigurations CLIENTSET_INFO_CONFIG_LIBNAME_SUFFIX
      The value for the clientset info configuration libname suffix attribute for the jedis client configuration with this configuration instance. The clientset info libname suffix on JedisClientConfig. The default value is not defined.
  • Method Details

    • values

      public static ValkeyConfigurations[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ValkeyConfigurations valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • get

      public String get()
      Specified by:
      get in interface Supplier<String>