final case class UserFunctionError(message: String = "", code: String = "", detail: String = "", sourceLocations: Seq[SourceLocation] = _root_.scala.Seq.empty, severity: Severity = kalix.protocol.discovery.UserFunctionError.Severity.UNSPECIFIED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[UserFunctionError] with Product with Serializable

An error detected by the proxy to be reported to the user.

The function should attempt to load the source code for any source code locations present in the file, and use the information in the source code location to extract the relevant lines of code, and highlight the column with a caret. For example, this is what an error may look like:

ERROR: KLX-00023 Event sourced entity method GetCart input parameter GetCartRequest does not declare a field with an component id. To fix this issue, annotate one of the fields in GetCartRequest with kalix.field.id, for example, if the first field, id, is the component id, you might add this:

string id = 1 [(kalix.field).id = true];

At shoppingcart.proto:15: rpc GetCart(GetCartRequest) returns (Cart); ^ At shoppingcart.proto:63: message GetCartRequest { string id = 1; }

message

A single line message that describes the error. This message should always be displayed when the error is rendered.

code

The error code. Each class of error has a unique code. Typically this code should be displayed before the error message.

detail

A longer message explaining the error. This message may be multiple lines long, may include suggestions of how to fix the error, code snippets, URLs to go and read for more information, etc. If a user has configured logging to be less verbose, this detail may be left off, or in a UI may be hidden in an expandable section.

sourceLocations

Zero or more source locations that are associated with this error. If the error is in a protobuf descriptor, this should contain at least one location.

Annotations
@SerialVersionUID()
Source
UserFunctionError.scala
Linear Supertypes
Updatable[UserFunctionError], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UserFunctionError
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new UserFunctionError(message: String = "", code: String = "", detail: String = "", sourceLocations: Seq[SourceLocation] = _root_.scala.Seq.empty, severity: Severity = kalix.protocol.discovery.UserFunctionError.Severity.UNSPECIFIED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    message

    A single line message that describes the error. This message should always be displayed when the error is rendered.

    code

    The error code. Each class of error has a unique code. Typically this code should be displayed before the error message.

    detail

    A longer message explaining the error. This message may be multiple lines long, may include suggestions of how to fix the error, code snippets, URLs to go and read for more information, etc. If a user has configured logging to be less verbose, this detail may be left off, or in a UI may be hidden in an expandable section.

    sourceLocations

    Zero or more source locations that are associated with this error. If the error is in a protobuf descriptor, this should contain at least one location.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from UserFunctionError toany2stringadd[UserFunctionError] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (UserFunctionError, B)
    Implicit
    This member is added by an implicit conversion from UserFunctionError toArrowAssoc[UserFunctionError] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def addAllSourceLocations(__vs: Iterable[SourceLocation]): UserFunctionError
  7. def addSourceLocations(__vs: SourceLocation*): UserFunctionError
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clearSourceLocations: UserFunctionError
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. val code: String
  12. def companion: UserFunctionError.type
    Definition Classes
    UserFunctionError → GeneratedMessage
  13. val detail: String
  14. def discardUnknownFields: UserFunctionError
  15. def ensuring(cond: (UserFunctionError) => Boolean, msg: => Any): UserFunctionError
    Implicit
    This member is added by an implicit conversion from UserFunctionError toEnsuring[UserFunctionError] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (UserFunctionError) => Boolean): UserFunctionError
    Implicit
    This member is added by an implicit conversion from UserFunctionError toEnsuring[UserFunctionError] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: => Any): UserFunctionError
    Implicit
    This member is added by an implicit conversion from UserFunctionError toEnsuring[UserFunctionError] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): UserFunctionError
    Implicit
    This member is added by an implicit conversion from UserFunctionError toEnsuring[UserFunctionError] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    UserFunctionError → GeneratedMessage
  22. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    UserFunctionError → GeneratedMessage
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. val message: String
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. def productElementNames: Iterator[String]
    Definition Classes
    Product
  29. def serializedSize: Int
    Definition Classes
    UserFunctionError → GeneratedMessage
  30. val severity: Severity
  31. val sourceLocations: Seq[SourceLocation]
  32. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  33. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  34. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  35. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  36. def toProtoString: String
    Definition Classes
    UserFunctionError → GeneratedMessage
  37. val unknownFields: UnknownFieldSet
  38. def update(ms: (Lens[UserFunctionError, UserFunctionError]) => Mutation[UserFunctionError]*): UserFunctionError
    Definition Classes
    Updatable
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  42. def withCode(__v: String): UserFunctionError
  43. def withDetail(__v: String): UserFunctionError
  44. def withMessage(__v: String): UserFunctionError
  45. def withSeverity(__v: Severity): UserFunctionError
  46. def withSourceLocations(__v: Seq[SourceLocation]): UserFunctionError
  47. def withUnknownFields(__v: UnknownFieldSet): UserFunctionError
  48. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  49. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    UserFunctionError → GeneratedMessage
  50. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

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

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from UserFunctionError toStringFormat[UserFunctionError] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (UserFunctionError, B)
    Implicit
    This member is added by an implicit conversion from UserFunctionError toArrowAssoc[UserFunctionError] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Updatable[UserFunctionError]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromUserFunctionError to any2stringadd[UserFunctionError]

Inherited by implicit conversion StringFormat fromUserFunctionError to StringFormat[UserFunctionError]

Inherited by implicit conversion Ensuring fromUserFunctionError to Ensuring[UserFunctionError]

Inherited by implicit conversion ArrowAssoc fromUserFunctionError to ArrowAssoc[UserFunctionError]

Ungrouped