trait BaseAlarm extends BaseError

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BaseAlarm
  2. BaseError
  3. LocationMixin
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def cause: String

    A human readable string indicating the error

    A human readable string indicating the error

    Definition Classes
    BaseError
  2. abstract def code: AlarmErrorCode

    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
    BaseAlarmBaseError

Concrete 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(implicit logger: ContextualizedErrorLogger): StatusRuntimeException
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. def context: Map[String, String]

    The context (declared fields) of this error

    The context (declared fields) of this error

    Definition Classes
    BaseAlarmBaseError
  8. 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
    BaseError
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. 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
  15. def logWithContext(extra: Map[String, String] = Map())(implicit contextualizedErrorLogger: ContextualizedErrorLogger): Unit
    Definition Classes
    BaseError
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  19. def report()(implicit logger: ContextualizedErrorLogger): Unit

    Report the alarm to the logger.

  20. def reported()(implicit logger: ContextualizedErrorLogger): BaseAlarm.this.type

    Reports the alarm to the logger.

    Reports the alarm to the logger.

    returns

    this alarm

  21. 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
  22. 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
  23. def rpcStatus(overrideCode: Option[Code] = None)(implicit loggingContext: ContextualizedErrorLogger): Status
    Definition Classes
    BaseError
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def 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
    BaseError
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. 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 BaseError

Inherited from LocationMixin

Inherited from AnyRef

Inherited from Any

Ungrouped