Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package digitalasset
    Definition Classes
    com
  • package canton
    Definition Classes
    digitalasset
  • package ledger
    Definition Classes
    canton
  • package error
    Definition Classes
    ledger
  • package groups
    Definition Classes
    error
  • object CommandExecutionErrors extends CommandExecutionErrorGroup
    Definition Classes
    groups
    Annotations
    @Explanation(explanation = "Errors raised during the command execution phase of the command submission evaluation.")
  • object TimeExceeded extends ErrorCode
    Definition Classes
    CommandExecutionErrors
    Annotations
    @Explanation(explanation = """This error occurs when the interpretation of a command exceeded the time limit, defined
    |as the maximum time that can be assigned by the ledger when it starts processing the command.
    |It corresponds to the time assigned upon submission by the participant (the ledger time) + a tolerance
    |defined by the `ledgerTimeToRecordTimeTolerance` ledger configuration parameter.
    |Reasons for exceeding this limit can vary: the participant may be under high load, the command interpretation
    |may be very complex, or even run into an infinite loop due to a mistake in the Daml code.
    |"""
    )
    @Resolution(resolution = """Due to the halting problem, we cannot determine whether the interpretation will eventually complete.
    |As a developer: inspect your code for possible non-terminating loops or consider reducing its complexity.
    |As an operator: check and possibly update the resources allocated to the system, as well as the
    |time-related configuration parameters (see "Time on Daml Ledgers" in the "Daml Ledger Model Concepts" doc section
    |and the `set_ledger_time_record_time_tolerance` console command).
    |"""
    )
  • Reject

final case class Reject(reason: String)(implicit loggingContext: ContextualizedErrorLogger) extends DamlErrorWithDefiniteAnswer with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Reject
  2. Serializable
  3. Product
  4. Equals
  5. DamlErrorWithDefiniteAnswer
  6. DamlError
  7. ContextualizedError
  8. BaseError
  9. LocationMixin
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Reject(reason: String)(implicit loggingContext: ContextualizedErrorLogger)

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. def asGrpcError: StatusRuntimeException
    Definition Classes
    ContextualizedError
  5. def asGrpcStatus: Status
    Definition Classes
    ContextualizedError
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val cause: String

    A human readable string indicating the error

    A human readable string indicating the error

    Definition Classes
    DamlErrorWithDefiniteAnswerDamlErrorBaseError
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  9. implicit val code: ErrorCode

    The error code, usually passed in as implicit where the error class is defined

    The error code, usually passed in as implicit where the error class is defined

    Definition Classes
    DamlErrorWithDefiniteAnswerDamlErrorBaseError
  10. def context: Map[String, String]

    The context (declared fields) of this error

    The context (declared fields) of this error

    Definition Classes
    DamlErrorBaseError
  11. val definiteAnswer: Boolean
    Definition Classes
    DamlErrorWithDefiniteAnswer
  12. final def definiteAnswerO: Option[Boolean]

    Controls whether a definite_answer error detail is added to the gRPC status code

    Controls whether a definite_answer error detail is added to the gRPC status code

    Definition Classes
    DamlErrorWithDefiniteAnswerBaseError
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. implicit val errorContext: ContextualizedErrorLogger
    Definition Classes
    DamlErrorContextualizedError
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. 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
  18. def logWithContext(extra: Map[String, String] = Map())(implicit contextualizedErrorLogger: ContextualizedErrorLogger): Unit
    Definition Classes
    BaseError
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  22. def productElementNames: Iterator[String]
    Definition Classes
    Product
  23. val reason: String
  24. 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
  25. 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
    RejectBaseError
  26. def rpcStatus(overrideCode: Option[Code] = None)(implicit loggingContext: ContextualizedErrorLogger): Status
    Definition Classes
    BaseError
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. 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.

    Definition Classes
    DamlErrorWithDefiniteAnswerDamlErrorBaseError
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  31. 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
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DamlError

Inherited from ContextualizedError

Inherited from BaseError

Inherited from LocationMixin

Inherited from AnyRef

Inherited from Any

Ungrouped