Packages

final case class AdminWorkflowConfig(bongTestMaxLevel: NonNegativeInt = NonNegativeInt.tryCreate(0), pingResponseTimeout: NonNegativeFiniteDuration = NonNegativeFiniteDuration.ofSeconds(30), maxBongDuration: NonNegativeFiniteDuration = NonNegativeFiniteDuration.ofMinutes(15), retries: Boolean = true, autoLoadDar: Boolean = true) extends UniformCantonConfigValidation with Product with Serializable

Configuration options for Canton admin workflows like participant.health.ping

bongTestMaxLevel

Upper bound (exclusive) on the level of a bong that the participant can participate. Any bong with higher level will be vacuumed immediately. Default 0, which means it won't participate in any bongs.

pingResponseTimeout

How long we will attempt to respond to a ping request before giving up

maxBongDuration

Cap the maximum duration of a bong. Default is 15 minutes.

retries

If false (default true), we will not retry sending commands in case of failures

autoLoadDar

If set to true (default), we will load the admin workflow package automatically. Setting this to false will break some admin workflows.

Linear Supertypes
Serializable, Product, Equals, UniformCantonConfigValidation, CustomCantonConfigValidation, CantonConfigValidation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AdminWorkflowConfig
  2. Serializable
  3. Product
  4. Equals
  5. UniformCantonConfigValidation
  6. CustomCantonConfigValidation
  7. CantonConfigValidation
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AdminWorkflowConfig(bongTestMaxLevel: NonNegativeInt = NonNegativeInt.tryCreate(0), pingResponseTimeout: NonNegativeFiniteDuration = NonNegativeFiniteDuration.ofSeconds(30), maxBongDuration: NonNegativeFiniteDuration = NonNegativeFiniteDuration.ofMinutes(15), retries: Boolean = true, autoLoadDar: Boolean = true)

    bongTestMaxLevel

    Upper bound (exclusive) on the level of a bong that the participant can participate. Any bong with higher level will be vacuumed immediately. Default 0, which means it won't participate in any bongs.

    pingResponseTimeout

    How long we will attempt to respond to a ping request before giving up

    maxBongDuration

    Cap the maximum duration of a bong. Default is 15 minutes.

    retries

    If false (default true), we will not retry sending commands in case of failures

    autoLoadDar

    If set to true (default), we will load the admin workflow package automatically. Setting this to false will break some admin workflows.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val autoLoadDar: Boolean
  6. val bongTestMaxLevel: NonNegativeInt
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. final def doValidate(edition: CantonEdition): Seq[CantonConfigValidationError]

    Returns all validation errors that are specific to this Canton configuration class.

    Returns all validation errors that are specific to this Canton configuration class. Successful validation should return an empty sequence.

    Validation errors of subconfigurations should not be reported by this method, but via the type class derivation.

    Attributes
    protected
    Definition Classes
    UniformCantonConfigValidation → CustomCantonConfigValidation
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val maxBongDuration: NonNegativeFiniteDuration
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. val pingResponseTimeout: NonNegativeFiniteDuration
  17. def productElementNames: Iterator[String]
    Definition Classes
    Product
  18. val retries: Boolean
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. final def validate[T >: AdminWorkflowConfig.this.type](edition: CantonEdition)(implicit validator: CantonConfigValidator[T]): Either[NonEmpty[Seq[CantonConfigValidationError]], Unit]
    Definition Classes
    CantonConfigValidation
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from UniformCantonConfigValidation

Inherited from CustomCantonConfigValidation

Inherited from CantonConfigValidation

Inherited from AnyRef

Inherited from Any

Ungrouped