Packages

final case class Reject(cause: String, keyO: Option[GlobalKey] = None)(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(cause: String, keyO: Option[GlobalKey] = None)(implicit loggingContext: ContextualizedErrorLogger)

Value Members

  1. def asGrpcError: StatusRuntimeException
    Definition Classes
    ContextualizedError
  2. def asGrpcStatus: Status
    Definition Classes
    ContextualizedError
  3. val cause: String

    A human readable string indicating the error

    A human readable string indicating the error

    Definition Classes
    RejectDamlErrorWithDefiniteAnswerDamlErrorBaseError
  4. 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
  5. def context: Map[String, String]

    The context (declared fields) of this error

    The context (declared fields) of this error

    Definition Classes
    DamlErrorBaseError
  6. val definiteAnswer: Boolean
    Definition Classes
    DamlErrorWithDefiniteAnswer
  7. 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
  8. implicit val errorContext: ContextualizedErrorLogger
    Definition Classes
    DamlErrorContextualizedError
  9. val keyO: Option[GlobalKey]
  10. 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
  11. def logWithContext(extra: Map[String, String] = Map())(implicit contextualizedErrorLogger: ContextualizedErrorLogger): Unit
    Definition Classes
    BaseError
  12. def productElementNames: Iterator[String]
    Definition Classes
    Product
  13. 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
    RejectBaseError
  14. 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
  15. def rpcStatus(overrideCode: Option[Code] = None)(implicit loggingContext: ContextualizedErrorLogger): Status
    Definition Classes
    BaseError
  16. 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