consul4s.model.session
package consul4s.model.session
Members list
Type members
Classlikes
final case class NewSession(Node: Option[String], LockDelay: String, Name: Option[String], ID: Option[String], Checks: Option[List[String]], Behavior: SessionBehavior, TTL: Option[String])
Value parameters
- Behavior
-
- Controls the behavior to take when a session is invalidated.
- Checks
-
- specifies a list of associated health check IDs (commonly CheckID in API responses). It is highly recommended that, if you override this list, you include the default serfHealth.
- ID
-
- session id (uuid)
- LockDelay
-
- Specifies the duration for the lock delay. This must be greater than 0. Example: "15s"*
- Name
-
- Specifies a human-readable name for the session.
- Node
-
- Specifies the name of the node. This must refer to a node that is already registered.
- TTL
-
- Specifies the number of seconds (between 10s and 86400s). If provided, the session is invalidated if it is not renewed before the TTL expires. The lowest practical TTL should be used to keep the number of managed sessions low. When locks are forcibly expired, such as when following the leader election pattern in an application, sessions may not be reaped for up to double this TTL, so long TTL values (> 1 hour) should be avoided.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
final case class SessionId(ID: String) extends AnyVal
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass AnyValtrait Matchableclass AnyShow all
final case class SessionInfo(ID: String, Name: String, Node: String, LockDelay: Long, CreateIndex: Long, ModifyIndex: Long, ServiceChecks: Option[List[String]], NodeChecks: Option[List[String]], Behavior: SessionBehavior, TTL: String)
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
In this article