Class/Object

com.swoop.spark.records

Issue

Related Docs: object Issue | package records

Permalink

case class Issue(category: Int, message: String, causes: Option[Seq[Cause]] = None, id: Option[Int] = None, details: Option[String] = None) extends Product with Serializable

An issue is a container for diagnostic information including both simple fields and an optional sequence of causes.

category

The category of the issue. It matches the with the values coming from the different types of Issue$.ThrowableMessageType featureMask values.

message

The message related to the issue.

causes

The causes of this issue.

id

The issue ID.

details

Optional additional details for the issue. For root cause analysis purposes it is useful to to split messages we want to associate with records into a stable portion (the issue message) and a variable portion (the issue details). This enables stable grouping and counting.

See also

Issue$.messageWithDetails

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Issue
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Issue(category: Int, message: String, causes: Option[Seq[Cause]] = None, id: Option[Int] = None, details: Option[String] = None)

    Permalink

    category

    The category of the issue. It matches the with the values coming from the different types of Issue$.ThrowableMessageType featureMask values.

    message

    The message related to the issue.

    causes

    The causes of this issue.

    id

    The issue ID.

    details

    Optional additional details for the issue. For root cause analysis purposes it is useful to to split messages we want to associate with records into a stable portion (the issue message) and a variable portion (the issue details). This enables stable grouping and counting.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Issue to any2stringadd[Issue] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Issue, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Issue to ArrowAssoc[Issue] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. val category: Int

    Permalink

    The category of the issue.

    The category of the issue. It matches the with the values coming from the different types of Issue$.ThrowableMessageType featureMask values.

  8. val causes: Option[Seq[Cause]]

    Permalink

    The causes of this issue.

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. val details: Option[String]

    Permalink

    Optional additional details for the issue.

    Optional additional details for the issue. For root cause analysis purposes it is useful to to split messages we want to associate with records into a stable portion (the issue message) and a variable portion (the issue details). This enables stable grouping and counting.

  11. def ensuring(cond: (Issue) ⇒ Boolean, msg: ⇒ Any): Issue

    Permalink
    Implicit information
    This member is added by an implicit conversion from Issue to Ensuring[Issue] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: (Issue) ⇒ Boolean): Issue

    Permalink
    Implicit information
    This member is added by an implicit conversion from Issue to Ensuring[Issue] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean, msg: ⇒ Any): Issue

    Permalink
    Implicit information
    This member is added by an implicit conversion from Issue to Ensuring[Issue] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: Boolean): Issue

    Permalink
    Implicit information
    This member is added by an implicit conversion from Issue to Ensuring[Issue] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Issue to StringFormat[Issue] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  19. val id: Option[Int]

    Permalink

    The issue ID.

  20. def idMessage: Option[String]

    Permalink

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  22. val message: String

    Permalink

    The message related to the issue.

  23. def messageType: String

    Permalink

  24. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  28. def toString(): String

    Permalink
    Definition Classes
    Issue → AnyRef → Any

  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. def withShortStackTraces: Issue

    Permalink

    Returns a "lighter" issue by shortening stack traces.

    Returns a "lighter" issue by shortening stack traces.

    Shortening involves eliminating the common postfix, which is usually startup/initialization code.

  33. def withoutCauses: Issue

    Permalink

    Returns a "ligher" issue without causes

  34. def withoutStackTraces: Issue

    Permalink

    Returns a "lighter" issue without stack traces in the causes

  35. def →[B](y: B): (Issue, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Issue to ArrowAssoc[Issue] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Issue to any2stringadd[Issue]

Inherited by implicit conversion StringFormat from Issue to StringFormat[Issue]

Inherited by implicit conversion Ensuring from Issue to Ensuring[Issue]

Inherited by implicit conversion ArrowAssoc from Issue to ArrowAssoc[Issue]

Ungrouped