Packages

o

com.daml.error.definitions

LedgerApiErrors

object LedgerApiErrors extends LedgerApiErrorGroup

Annotations
@Explanation(explanation = "Errors raised by or forwarded by the Ledger API.")
Linear Supertypes
LedgerApiErrorGroup, ErrorGroup, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LedgerApiErrors
  2. LedgerApiErrorGroup
  3. ErrorGroup
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract class AdminServicesErrorGroup extends ErrorGroup
    Definition Classes
    LedgerApiErrorGroup
  2. abstract class AuthorizationChecks extends ErrorGroup
    Definition Classes
    LedgerApiErrorGroup
  3. abstract class CommandExecutionErrorGroup extends ErrorGroup
    Definition Classes
    LedgerApiErrorGroup
  4. abstract class ConsistencyErrors extends ErrorGroup
    Definition Classes
    LedgerApiErrorGroup
  5. abstract class PackageServiceErrorGroup extends ErrorGroup
    Definition Classes
    LedgerApiErrorGroup
  6. abstract class RequestValidation extends ErrorGroup
    Definition Classes
    LedgerApiErrorGroup
  7. abstract class WriteServiceRejections extends ErrorGroup
    Definition Classes
    LedgerApiErrorGroup

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. val Admin: AdminServices.type
  5. val AuthorizationChecks: groups.AuthorizationChecks.type
  6. val CommandExecution: groups.CommandExecution.type
  7. val ConsistencyErrors: groups.ConsistencyErrors.type
  8. val EarliestOffsetMetadataKey: String
  9. val RequestValidation: groups.RequestValidation.type
  10. val WriteServiceRejections: groups.WriteServiceRejections.type
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. implicit val errorClass: ErrorClass
    Definition Classes
    ErrorGroup
  16. val fullClassName: String
    Definition Classes
    ErrorGroup
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. object HeapMemoryOverLimit extends ErrorCode
    Annotations
    @Explanation(explanation = "This error happens when the JVM heap memory pool exceeds a pre-configured limit.") @Resolution(resolution = """The following actions can be taken:
    |1. Review the historical use of heap space by inspecting the metric given in the message.
    |2. Review the current heap space limits configured in the rate limiting configuration.
    |3. Try to space out requests that are likely to require a large amount of memory to process."""    )
  29. object InternalError extends ErrorCode
    Annotations
    @Explanation(explanation = """This error occurs if there was an unexpected error in the Ledger API.""") @Resolution(resolution = "Contact support.")
  30. object MaximumNumberOfStreams extends ErrorCode
    Annotations
    @Explanation(explanation = "This error happens when the number of concurrent gRPC streaming requests exceeds the configured limit.") @Resolution(resolution = """The following actions can be taken:
    |1. Review the historical need for concurrent streaming by inspecting the metric given in the message.
    |2. Review the maximum streams limit configured in the rate limiting configuration.
    |3. Try to space out streaming requests such that they do not need to run in parallel with each other."""    )
  31. object ParticipantBackpressure extends ErrorCode
    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 requests from other participants through a connected domain."""    )     @Resolution(resolution = """Wait a bit and retry, preferably with some backoff factor.
    |If possible, ask other participants to send fewer requests; the domain operator can enforce this by imposing a rate limit."""    )
  32. object RequestTimeOut extends ErrorCode
    Annotations
    @Explanation(explanation = "This rejection is given when a request processing status is not known and a time-out is reached.") @Resolution(resolution = "Retry for transient problems. If non-transient contact the operator as the time-out limit might be too short.")
  33. object ServerIsShuttingDown extends ErrorCode
    Annotations
    @Explanation(explanation = "This rejection is given when the participant server is shutting down.") @Resolution(resolution = "Contact the participant operator.")
  34. object ServiceNotRunning extends ErrorCode
    Annotations
    @Explanation(explanation = "This rejection is given when the requested service has already been closed.") @Resolution(resolution = "Retry re-submitting the request. If the error persists, contact the participant operator.")
  35. object ThreadpoolOverloaded extends ErrorCode
    Annotations
    @Explanation(explanation = "This happens when the rate of submitted gRPC requests requires more CPU or database power than is available.") @Resolution(resolution = """The following actions can be taken:
    |Here the 'queue size' for the threadpool = 'submitted tasks' - 'completed tasks' - 'running tasks'
    |1. Review the historical 'queue size' growth by inspecting the metric given in the message.
    |2. Review the maximum 'queue size' limits configured in the rate limiting configuration.
    |3. Try to space out requests that are likely to require a lot of CPU or database power.
    """    )
  36. object UnsupportedOperation extends ErrorCode
    Annotations
    @Explanation(explanation = """This error category is used to signal that an unimplemented code-path has been triggered by a client or participant operator request.""") @Resolution(resolution = """This error is caused by a participant node misconfiguration or by an implementation bug.
    |Resolution requires participant operator intervention."""    )

Deprecated Value Members

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

Inherited from LedgerApiErrorGroup

Inherited from ErrorGroup

Inherited from AnyRef

Inherited from Any

Ungrouped