Packages

c

org.checkita.dqf.core.Results

CheckCalculatorResult

final case class CheckCalculatorResult(checkId: String, checkName: String, sourceIds: Seq[String], baseMetric: String, comparedMetric: Seq[String], comparedThreshold: Option[Double], lowerBound: Option[Double], upperBound: Option[Double], status: CalculatorStatus, message: String, resultType: ResultType = ResultType.Check) extends TypedResult with Product with Serializable

Check calculator result.

checkId

Check ID

checkName

Check calculator name

baseMetric

Base metric used to build check

comparedMetric

Sequence of metrics to compare with.

comparedThreshold

Threshold to compare with

lowerBound

Allowed lower bound for base metric value

upperBound

Allowed upper bound for base metric value

status

Check status

message

Check message

resultType

Type of result

Note

Expression checks can utilize multiple metrics. Therefore, compareMetric field is represented as sequence: when compare metric is absent the empty sequence will be written, otherwise sequence containing one or more metric IDs will be written.

Linear Supertypes
Serializable, Serializable, Product, Equals, TypedResult, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CheckCalculatorResult
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. TypedResult
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CheckCalculatorResult(checkId: String, checkName: String, sourceIds: Seq[String], baseMetric: String, comparedMetric: Seq[String], comparedThreshold: Option[Double], lowerBound: Option[Double], upperBound: Option[Double], status: CalculatorStatus, message: String, resultType: ResultType = ResultType.Check)

    checkId

    Check ID

    checkName

    Check calculator name

    baseMetric

    Base metric used to build check

    comparedMetric

    Sequence of metrics to compare with.

    comparedThreshold

    Threshold to compare with

    lowerBound

    Allowed lower bound for base metric value

    upperBound

    Allowed upper bound for base metric value

    status

    Check status

    message

    Check message

    resultType

    Type of result

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val baseMetric: String
  6. val checkId: String
  7. val checkName: String
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. val comparedMetric: Seq[String]
  10. val comparedThreshold: Option[Double]
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def finalize(description: Option[String], metadata: Option[String], isCritical: Boolean)(implicit jobId: String, settings: AppSettings): ResultCheck

    Converts check calculator result to final check result representation suitable for storing into results storage and sending via targets.

    Converts check calculator result to final check result representation suitable for storing into results storage and sending via targets.

    description

    Check description

    metadata

    Metadata parameters specific to this check (JSON List string)

    jobId

    Implicit Job ID

    settings

    Implicit application settings object

    returns

    Finalized check result

  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val lowerBound: Option[Double]
  17. val message: String
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. val resultType: ResultType
    Definition Classes
    CheckCalculatorResult → TypedResult
  22. val sourceIds: Seq[String]
  23. val status: CalculatorStatus
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. val upperBound: Option[Double]
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from TypedResult

Inherited from AnyRef

Inherited from Any

Ungrouped