Record Class JobLevelEffect

java.lang.Object
java.lang.Record
com.kingsrook.qqq.backend.core.jobs.effects.JobLevelEffect
Record Components:
effectName - e.g. "deliver"
targetName - a target registered in DurableJobsMetaData.effectTargets
effectType - IDEMPOTENT_EXTERNAL or NON_IDEMPOTENT_EXTERNAL
rowKey - a stable key for this effect within the job (e.g., the destination id), part of the idempotency key
payload - small values for the target
payloadRef - a reference to a larger stored payload, or null
public record JobLevelEffect(String effectName, String targetName, JobEffectType effectType, String rowKey, Map<String,Serializable> payload, String payloadRef) extends Record
One job-level effect a JobCompletionEffects provider asks for.

  • Constructor Details

    • JobLevelEffect

      public JobLevelEffect(String effectName, String targetName, JobEffectType effectType, String rowKey, Map<String,Serializable> payload, String payloadRef)
      Creates an instance of a JobLevelEffect record class.
      Parameters:
      effectName - the value for the effectName record component
      targetName - the value for the targetName record component
      effectType - the value for the effectType record component
      rowKey - the value for the rowKey record component
      payload - the value for the payload record component
      payloadRef - the value for the payloadRef 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • effectName

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

    • targetName

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

    • effectType

      public JobEffectType effectType()
      Returns the value of the effectType record component.
      Returns:
      the value of the effectType record component

    • rowKey

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

    • payload

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

    • payloadRef

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