case object GenericConfigError extends ConfigErrorCode with Product with Serializable
- Annotations
- @Resolution(resolution = """ In general, this can be one of many errors since this is the 'miscellaneous category' of configuration errors.
| One of the more common errors in this category is an 'unknown key' error. This error usually means that
| a keyword that is not valid (e.g. it may have a typo 'bort' instead of 'port'), or that a valid keyword
| at the wrong part of the configuration hierarchy was used (e.g. to enable database replication for a participant, the correct configuration
| is `canton.participants.participant2.replication.enabled = true` and not `canton.participants.replication.enabled = true`).
| Please refer to the scaladoc of either `CantonEnterpriseConfig` or `CantonCommunityConfig` (depending on whether the community or enterprise version is used) to find the valid configuration keywords and the correct position in the configuration hierarchy.
|""")
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- GenericConfigError
- Serializable
- Product
- Equals
- ConfigErrorCode
- ErrorCode
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Type Members
- final case class Error(cause: String)(implicit loggingContext: ErrorLoggingContext) extends CantonConfigError with Product with Serializable
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val category: ErrorCategory
- Definition Classes
- ErrorCode
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- implicit val code: ErrorCode
- Definition Classes
- ErrorCode
- def codeStr(correlationId: Option[String]): String
The machine readable error code string, uniquely identifiable by the error id, error category and correlation id.
The machine readable error code string, uniquely identifiable by the error id, error category and correlation id. e.g. NO_DOMAINS_CONNECTED(2,ABC234)
- Definition Classes
- ErrorCode
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def errorConveyanceDocString: Option[String]
The error conveyance doc string provides a statement about the form this error will be returned to the user
The error conveyance doc string provides a statement about the form this error will be returned to the user
- Definition Classes
- ConfigErrorCode → ErrorCode
- def exposedViaApi: Boolean
True if this error may appear on the API
True if this error may appear on the API
- Attributes
- protected
- Definition Classes
- ErrorCode
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- val id: String
- Definition Classes
- ErrorCode
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def logLevel: Level
Log level of the error code
Log level of the error code
Generally, the log level is defined by the error category. In rare cases, it might be overridden by the error code.
- Definition Classes
- ConfigErrorCode → ErrorCode
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- implicit val parent: ErrorClass
- Definition Classes
- ErrorCode
- def productElementName(n: Int): String
- Definition Classes
- Product
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toMsg(cause: => String, correlationId: Option[String], limit: Option[Int]): String
- returns
message including error category id, error code id, correlation id and cause
- Definition Classes
- ErrorCode
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])