final case class Failure(reason: String)(implicit loggingContext: ErrorLoggingContext) extends Alarm with TopologyManagerError with Product with Serializable
- Alphabetic
- By Inheritance
- Failure
- Serializable
- Product
- Equals
- TopologyManagerError
- ContextualizedCantonError
- LogOnCreation
- RpcError
- CantonBaseError
- Alarm
- BaseAlarm
- BaseError
- LocationMixin
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Failure(reason: String)(implicit loggingContext: ErrorLoggingContext)
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
- def asGoogleGrpcStatus(implicit loggingContext: ErrorLoggingContext): Status
- Definition Classes
- CantonBaseError
- def asGrpcError: StatusRuntimeException
The gRPC status encoded as a StatusRuntimeException
The gRPC status encoded as a StatusRuntimeException
- Definition Classes
- ContextualizedCantonError → RpcError
- def asGrpcError(implicit loggingContext: ErrorLoggingContext): StatusRuntimeException
- Definition Classes
- CantonBaseError
- def asGrpcError(implicit logger: BaseErrorLogger): StatusRuntimeException
- Definition Classes
- BaseAlarm
- def asGrpcStatus: Status
The gRPC status
The gRPC status
- Definition Classes
- ContextualizedCantonError → RpcError
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val cause: String
A human readable string indicating the error
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- implicit val code: AlarmErrorCode
The error code, usually passed in as implicit where the error class is defined
- def context: Map[String, String]
The context (declared fields) of this error
The context (declared fields) of this error
- Definition Classes
- CantonBaseError → BaseError
- def correlationId: Option[String]
The correlationId (e.g.
The correlationId (e.g. submissionId) associated with the request that caused the error
- Definition Classes
- ContextualizedCantonError → RpcError
- def definiteAnswerO: Option[Boolean]
Controls whether a
definite_answererror detail is added to the gRPC status codeControls whether a
definite_answererror detail is added to the gRPC status code- Definition Classes
- BaseError
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val location: Option[String]
Contains the location where the error has been created.
Contains the location where the error has been created.
- Definition Classes
- LocationMixin
- def log()(implicit loggingContext: ErrorLoggingContext): Unit
- Definition Classes
- CantonBaseError
- def logError(): Unit
- Definition Classes
- ContextualizedCantonError → LogOnCreation
- def logOnCreation: Boolean
Flag to control if an error should be logged at creation Generally, we do want to log upon creation, except in the case of "nested" or combined errors, where we just nest the error but don't want it to be logged twice.
Flag to control if an error should be logged at creation Generally, we do want to log upon creation, except in the case of "nested" or combined errors, where we just nest the error but don't want it to be logged twice. See com.digitalasset.canton.error.ParentCantonError as an example.
- Definition Classes
- ContextualizedCantonError → LogOnCreation
- def logWithContext(extra: Map[String, String] = Map())(implicit errorLoggingContext: BaseErrorLogger): Unit
- Definition Classes
- BaseError
- def logger: ErrorLoggingContext
- Definition Classes
- ContextualizedCantonError
- implicit val loggingContext: ErrorLoggingContext
The logging context obtained when we created the error, usually passed in as implicit via com.digitalasset.canton.logging.NamedLogging
The logging context obtained when we created the error, usually passed in as implicit via com.digitalasset.canton.logging.NamedLogging
- Definition Classes
- Failure → ContextualizedCantonError
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val reason: String
- def report()(implicit logger: BaseErrorLogger): Unit
Report the alarm to the logger.
Report the alarm to the logger.
- Definition Classes
- BaseAlarm
- def reported()(implicit logger: BaseErrorLogger): Failure.this.type
Reports the alarm to the logger.
- def resources: Seq[(ErrorResource, String)]
The resources related to this error
The resources related to this error
We return the set of resources via com.google.rpc.ResourceInfo. Override this method in order to return resource information via com.google.rpc.Status
- Definition Classes
- BaseError
- def retryable: Option[ErrorCategoryRetry]
Returns retryability information of this particular error
Returns retryability information of this particular error
In some cases, error instances would like to provide custom retry intervals. This can be achieved by locally overriding this method.
Do not use this to change the contract of the error categories. Non-retryable errors shouldn't be made retryable. Only use it for adjusting the retry intervals.
- Definition Classes
- BaseError
- def rpcStatus()(implicit loggingContext: BaseErrorLogger): Status
- Definition Classes
- BaseError
- def rpcStatusWithoutLoggingContext(): Status
- Definition Classes
- CantonBaseError
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val throwableO: Option[Throwable]
An optional argument to log exceptions
An optional argument to log exceptions
If you want to log an exception as part of your error, then use the following example:
object MyCode extends ErrorCode(id="SUPER_DUPER_ERROR") { case class MyError(someString: String, throwable: Throwable) extends SomeInternalError( cause = "Something failed with an exception bla", throwableO = Some(throwable) ) }
NOTE: This throwable's details are not included the exception communicated to the gRPC clients so if you want them communicated, you need to explicitly add them to the e.g. context map or cause string.
- def toCantonRpcError(implicit loggingContext: ErrorLoggingContext): RpcError
- Definition Classes
- CantonBaseError
- def traceId: Option[String]
The traceId associated with the TraceContext at error creation
The traceId associated with the TraceContext at error creation
- Definition Classes
- ContextualizedCantonError → RpcError
- 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])