object LedgerApiErrors extends LedgerApiErrorGroup
- Annotations
- @Explanation(explanation = "Errors raised by or forwarded by the Ledger API.")
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- LedgerApiErrors
- LedgerApiErrorGroup
- ErrorGroup
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
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
- val EarliestOffsetMetadataKey: String
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit val errorClass: ErrorClass
- Definition Classes
- ErrorGroup
- val fullClassName: String
- Definition Classes
- ErrorGroup
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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])
- 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.""")
- object InternalError extends ErrorCode
- Annotations
- @Explanation(explanation = """This error occurs if there was an unexpected error in the Ledger API.""") @Resolution(resolution = "Contact support.")
- 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.""")
- 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.""")
- 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 is considered as reported by the executor itself.
|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.
""")