NewSession

consul4s.model.session.NewSession
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

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product