Packages

final case class RedisUriConfig(endpoint: RedisEndpoint, credentials: Option[RedisCredentials] = None, tls: Option[TlsConfig] = None, database: Option[Int] = None, timeout: Option[FiniteDuration] = None, clientName: Option[String] = None, libraryName: Option[String] = None, libraryVersion: Option[String] = None) extends Product with Serializable

Type-safe configuration for constructing a RedisURI with parity to Lettuce's RedisURI.

Cross-cutting options (tls, database, timeout, etc.) are applied as given and are not validated against the chosen endpoint. For example, combining RedisEndpoint.Socket with tls produces a URI carrying SSL flags even though TLS over a unix socket is unusual; this mirrors Lettuce, which performs no such validation either.

Source
RedisUriConfig.scala
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RedisUriConfig
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RedisUriConfig(endpoint: RedisEndpoint, credentials: Option[RedisCredentials] = None, tls: Option[TlsConfig] = None, database: Option[Int] = None, timeout: Option[FiniteDuration] = None, clientName: Option[String] = None, libraryName: Option[String] = None, libraryVersion: Option[String] = None)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from RedisUriConfig toany2stringadd[RedisUriConfig] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (RedisUriConfig, B)
    Implicit
    This member is added by an implicit conversion from RedisUriConfig toArrowAssoc[RedisUriConfig] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val clientName: Option[String]
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  9. val credentials: Option[RedisCredentials]
  10. val database: Option[Int]
  11. val endpoint: RedisEndpoint
  12. def ensuring(cond: (RedisUriConfig) => Boolean, msg: => Any): RedisUriConfig
    Implicit
    This member is added by an implicit conversion from RedisUriConfig toEnsuring[RedisUriConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (RedisUriConfig) => Boolean): RedisUriConfig
    Implicit
    This member is added by an implicit conversion from RedisUriConfig toEnsuring[RedisUriConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): RedisUriConfig
    Implicit
    This member is added by an implicit conversion from RedisUriConfig toEnsuring[RedisUriConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): RedisUriConfig
    Implicit
    This member is added by an implicit conversion from RedisUriConfig toEnsuring[RedisUriConfig] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. val libraryName: Option[String]
  20. val libraryVersion: Option[String]
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. val timeout: Option[FiniteDuration]
  27. val tls: Option[TlsConfig]
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. def withClientName(clientName: String): RedisUriConfig
  32. def withCredentials(credentials: RedisCredentials): RedisUriConfig
  33. def withDatabase(database: Int): RedisUriConfig
  34. def withLibraryName(libraryName: String): RedisUriConfig
  35. def withLibraryVersion(libraryVersion: String): RedisUriConfig
  36. def withTimeout(timeout: FiniteDuration): RedisUriConfig
  37. def withTls(tls: TlsConfig = TlsConfig()): RedisUriConfig

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from RedisUriConfig toStringFormat[RedisUriConfig] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (RedisUriConfig, B)
    Implicit
    This member is added by an implicit conversion from RedisUriConfig toArrowAssoc[RedisUriConfig] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromRedisUriConfig to any2stringadd[RedisUriConfig]

Inherited by implicit conversion StringFormat fromRedisUriConfig to StringFormat[RedisUriConfig]

Inherited by implicit conversion Ensuring fromRedisUriConfig to Ensuring[RedisUriConfig]

Inherited by implicit conversion ArrowAssoc fromRedisUriConfig to ArrowAssoc[RedisUriConfig]

Ungrouped