Package com.xebialabs.xlrelease.domain.tasks.plugin

Record Class PluginTaskResults

java.lang.Object
java.lang.Record
com.xebialabs.xlrelease.domain.tasks.plugin.PluginTaskResults
Record Components:
outputProperties - values the extension set, by declared property name
executionId - the task execution this belongs to; used to discard results from an execution that was already aborted
statusLine - the task's status line, or null to leave it alone
resumeDelaySeconds - re-enter after this many seconds; null unless the extension returned suspendFor
awaitSignal - the extension returned awaitSignal: stay in progress with no timer queued
All Implemented Interfaces:
Serializable
public record PluginTaskResults(Map<String,Object> outputProperties, String executionId, String statusLine, Integer resumeDelaySeconds, boolean awaitSignal) extends Record implements Serializable
What one execution of a plugin task produced, on its way from the worker back to the release actor.

Deliberately unrelated to DefaultScriptService.BaseScriptTaskResults: a plugin task has no script, and it travels on its own actor messages (FinishPluginTask, FailPluginTask, SavePluginTaskResults) to be applied by PluginTaskResultsService. Serializable for the same reason the script results are - it crosses an actor boundary.

See Also:

  • Constructor Details

    • PluginTaskResults

      public PluginTaskResults(Map<String,Object> outputProperties, String executionId, String statusLine, Integer resumeDelaySeconds, boolean awaitSignal)
      Creates an instance of a PluginTaskResults record class.
      Parameters:
      outputProperties - the value for the outputProperties record component
      executionId - the value for the executionId record component
      statusLine - the value for the statusLine record component
      resumeDelaySeconds - the value for the resumeDelaySeconds record component
      awaitSignal - the value for the awaitSignal record component

  • Method Details

    • isSuspending

      public boolean isSuspending()
      True when this execution asked to be re-entered, by either flavour.

    • 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.

    • outputProperties

      public Map<String,Object> outputProperties()
      Returns the value of the outputProperties record component.
      Returns:
      the value of the outputProperties record component

    • executionId

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

    • statusLine

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

    • resumeDelaySeconds

      public Integer resumeDelaySeconds()
      Returns the value of the resumeDelaySeconds record component.
      Returns:
      the value of the resumeDelaySeconds record component

    • awaitSignal

      public boolean awaitSignal()
      Returns the value of the awaitSignal record component.
      Returns:
      the value of the awaitSignal record component