Package dev.dokimos.server.dto.v1

Record Class RegressionAlertPayload

java.lang.Object
java.lang.Record
dev.dokimos.server.dto.v1.RegressionAlertPayload
Record Components:
projectName - the project the run belongs to
experimentId - the experiment the run belongs to
experimentName - the experiment name
runId - the candidate run that regressed
baselineRunId - the baseline run it was compared against
baselinePassRate - the baseline run's pass rate
candidatePassRate - the candidate run's pass rate
passRateDelta - candidate minus baseline pass rate (negative on a regression)
regressedCaseCount - the number of items that regressed
public record RegressionAlertPayload(String projectName, UUID experimentId, String experimentName, UUID runId, UUID baselineRunId, double baselinePassRate, double candidatePassRate, double passRateDelta, int regressedCaseCount) extends Record
JSON body POSTed to a project's alert webhooks when a completed run regresses against its baseline. Carries enough context to identify the regression without a follow-up API call.

  • Constructor Details

    • RegressionAlertPayload

      public RegressionAlertPayload(String projectName, UUID experimentId, String experimentName, UUID runId, UUID baselineRunId, double baselinePassRate, double candidatePassRate, double passRateDelta, int regressedCaseCount)
      Creates an instance of a RegressionAlertPayload record class.
      Parameters:
      projectName - the value for the projectName record component
      experimentId - the value for the experimentId record component
      experimentName - the value for the experimentName record component
      runId - the value for the runId record component
      baselineRunId - the value for the baselineRunId record component
      baselinePassRate - the value for the baselinePassRate record component
      candidatePassRate - the value for the candidatePassRate record component
      passRateDelta - the value for the passRateDelta record component
      regressedCaseCount - the value for the regressedCaseCount record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • projectName

      public String projectName()
      Returns the value of the projectName record component.
      Returns:
      the value of the projectName record component

    • experimentId

      public UUID experimentId()
      Returns the value of the experimentId record component.
      Returns:
      the value of the experimentId record component

    • experimentName

      public String experimentName()
      Returns the value of the experimentName record component.
      Returns:
      the value of the experimentName record component

    • runId

      public UUID runId()
      Returns the value of the runId record component.
      Returns:
      the value of the runId record component

    • baselineRunId

      public UUID baselineRunId()
      Returns the value of the baselineRunId record component.
      Returns:
      the value of the baselineRunId record component

    • baselinePassRate

      public double baselinePassRate()
      Returns the value of the baselinePassRate record component.
      Returns:
      the value of the baselinePassRate record component

    • candidatePassRate

      public double candidatePassRate()
      Returns the value of the candidatePassRate record component.
      Returns:
      the value of the candidatePassRate record component

    • passRateDelta

      public double passRateDelta()
      Returns the value of the passRateDelta record component.
      Returns:
      the value of the passRateDelta record component

    • regressedCaseCount

      public int regressedCaseCount()
      Returns the value of the regressedCaseCount record component.
      Returns:
      the value of the regressedCaseCount record component