Enum Class ValkeyClusterConfigurations

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

public enum ValkeyClusterConfigurations extends Enum<ValkeyClusterConfigurations> implements Supplier<String>
An enumeration to show the available options to connect to the Redis database by cluster configuration. 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 cluster jedis client configuration with this configuration instance.
    The value for the clientset info configuration libname suffix attribute for the cluster jedis client configuration with this configuration instance.
    The key property that defines if the redis cluster configuration should be loaded
    The value for the sentinel HOST:PORT (separated by comma) configuration attribute for the jedis client configuration with this configuration instance.
    The value for the max attempts configuration attribute for the cluster jedis client configuration with this configuration instance.
    The value for the max total retries configuration attribute for the cluster jedis client configuration with this configuration instance.
    The value for the connection timeout in milliseconds configuration attribute for the cluster jedis client configuration created with this configuration instance.
    The value for the password configuration attribute for the cluster jedis client configuration with this configuration instance.
    The value for the protocol configuration attribute for the cluster jedis client configuration with this configuration instance.
    The value for the socket timeout in milliseconds configuration attribute for the cluster jedis client configuration with this configuration instance.
    The value for the ssl configuration attribute for the cluster jedis client configuration with this configuration instance.
    The cluster redis timeout, the default value is Protocol.DEFAULT_TIMEOUT on milliseconds
    The value for the user configuration attribute for the cluster 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

    • CLUSTER

      public static final ValkeyClusterConfigurations CLUSTER
      The key property that defines if the redis cluster configuration should be loaded
    • CLUSTER_HOSTS

      public static final ValkeyClusterConfigurations CLUSTER_HOSTS
      The value for the sentinel HOST:PORT (separated by comma) configuration attribute for the jedis client configuration with this configuration instance.
    • CLIENT_NAME

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

      public static final ValkeyClusterConfigurations TIMEOUT
      The cluster redis timeout, the default value is Protocol.DEFAULT_TIMEOUT on milliseconds
    • CONNECTION_TIMEOUT

      public static final ValkeyClusterConfigurations CONNECTION_TIMEOUT
      The value for the connection timeout in milliseconds configuration attribute for the cluster 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 ValkeyClusterConfigurations SOCKET_TIMEOUT
      The value for the socket timeout in milliseconds configuration attribute for the cluster 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 ValkeyClusterConfigurations USER
      The value for the user configuration attribute for the cluster jedis client configuration with this configuration instance. The user on JedisClientConfig
    • PASSWORD

      public static final ValkeyClusterConfigurations PASSWORD
      The value for the password configuration attribute for the cluster jedis client configuration with this configuration instance. The user on JedisClientConfig
    • SSL

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

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

      public static final ValkeyClusterConfigurations CLIENTSET_INFO_CONFIG_DISABLED
      The value for the clientset info disabled configuration attribute for the cluster 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 ValkeyClusterConfigurations CLIENTSET_INFO_CONFIG_LIBNAME_SUFFIX
      The value for the clientset info configuration libname suffix attribute for the cluster jedis client configuration with this configuration instance. The clientset info libname suffix on JedisClientConfig The default value is not defined.
    • CLUSTER_MAX_ATTEMPTS

      public static final ValkeyClusterConfigurations CLUSTER_MAX_ATTEMPTS
      The value for the max attempts configuration attribute for the cluster jedis client configuration with this configuration instance. Default is JedisCluster.DEFAULT_MAX_ATTEMPTS
    • CLUSTER_MAX_TOTAL_RETRIES_DURATION

      public static final ValkeyClusterConfigurations CLUSTER_MAX_TOTAL_RETRIES_DURATION
      The value for the max total retries configuration attribute for the cluster jedis client configuration with this configuration instance. Default is SOCKET_TIMEOUT * CLUSTER_MAX_ATTEMPTS
  • Method Details

    • values

      public static ValkeyClusterConfigurations[] 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 ValkeyClusterConfigurations 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>