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
  • object LedgerApiErrors extends LedgerApiErrorGroup
    Definition Classes
    error
    Annotations
    @Explanation(explanation = "Errors raised by or forwarded by the Ledger API.")
  • object ParticipantBackpressure extends ErrorCode
    Definition Classes
    LedgerApiErrors
    Annotations
    @Explanation(explanation = """This error occurs when a participant rejects a command due to excessive load.
    |Load can be caused by the following factors:
    |1. when commands are submitted to the participant through its Ledger API,
    |2. when the participant receives validation requests from other participants through a connected synchronizer.
    |
    |In order to prevent the participant of being overloaded, it will start to reject commands once a
    |certain load threshold is reached. The main threshold is the number of in-flight validation requests
    |that the participant is currently processing. These requests can be caused either by this participant
    |or by other participants.
    |
    |For a submission to be counted as an in-flight validation request, the participant must first
    |observe its sequencing, which means that there is a delay between the submission and the submitted
    |command to be counted towards the currently in-flight validation requests. In order to avoid an
    |overload situation by a sudden burst of commands, the participant will also enforce a rate limit
    |before a submission is accepted for interpretation. This rate limit can be configured with a steady
    |state rate and a burst factor. The burst factor is a multiplier of the steady state rate that allows
    |for a certain number of commands to be submitted in a burst before the rate limit kicks in.
    |
    |As an example, with a rate limit of 1000 commands per second and a burst factor of 2, the rate limit
    |will kick in once 2000 commands have been submitted on top of the commands allowed by the rate limit.
    |
    |"""
    )
    @Resolution(resolution = """Verify the limits configured, the load and the command latency on the participant and adjust if necessary.
    |If the participant is highly loaded, ensure that your application waits some time with the resubmission, preferably with some backoff factor.
    |If possible, ask other participants to send fewer requests; the synchronizer operator can enforce this by imposing a rate limit."""
    )
  • Rejection

final case class Rejection(reason: String)(implicit errorLogger: ErrorLoggingContext) extends DamlErrorWithDefiniteAnswer with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Rejection
  2. Serializable
  3. Product
  4. Equals
  5. DamlErrorWithDefiniteAnswer
  6. ContextualizedDamlError
  7. LogOnCreation
  8. RpcError
  9. BaseError
  10. LocationMixin
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Rejection(reason: String)(implicit errorLogger: ErrorLoggingContext)

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

    The gRPC status encoded as a StatusRuntimeException

    The gRPC status encoded as a StatusRuntimeException

    Definition Classes
    ContextualizedDamlErrorRpcError
  5. def asGrpcStatus: Status

    The gRPC status

    The gRPC status

    Definition Classes
    ContextualizedDamlErrorRpcError
  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
    DamlErrorWithDefiniteAnswerContextualizedDamlErrorRpcErrorBaseError
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  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
    DamlErrorWithDefiniteAnswerContextualizedDamlErrorRpcErrorBaseError
  10. def context: Map[String, String]

    The context (declared fields) of this error

    The context (declared fields) of this error

    Definition Classes
    ContextualizedDamlErrorRpcErrorBaseError
  11. def correlationId: Option[String]

    The correlationId (e.g.

    The correlationId (e.g. submissionId) associated with the request that caused the error

    Definition Classes
    ContextualizedDamlErrorRpcError
  12. val definiteAnswer: Boolean
    Definition Classes
    DamlErrorWithDefiniteAnswer
  13. 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
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  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 logError(): Unit
  19. def logOnCreation: Boolean
  20. def logWithContext(extra: Map[String, String] = Map())(implicit errorLoggingContext: BaseErrorLogger): Unit
    Definition Classes
    BaseError
  21. implicit val logger: BaseErrorLogger
    Definition Classes
    ContextualizedDamlError
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. val reason: String
  27. 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
  28. 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
  29. def rpcStatus()(implicit loggingContext: BaseErrorLogger): Status
    Definition Classes
    BaseError
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. 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
    DamlErrorWithDefiniteAnswerContextualizedDamlErrorBaseError
  32. def traceId: Option[String]

    The traceId associated with the TraceContext at error creation

    The traceId associated with the TraceContext at error creation

    Definition Classes
    ContextualizedDamlErrorRpcError
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  35. 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 LogOnCreation

Inherited from RpcError

Inherited from BaseError

Inherited from LocationMixin

Inherited from AnyRef

Inherited from Any

Ungrouped