Record Class EffectRequest

java.lang.Object
java.lang.Record
com.kingsrook.qqq.backend.core.jobs.effects.EffectRequest
Record Components:
idempotencyKey - jobId:chunkSeq:rowKey:effectName - send it as the provider's Idempotency-Key, use it for object names, upsert keys or the email Message-ID (see EffectKeys)
effectName - the declared effect name
effectType - how the effect is made safe
jobId - the job (null outside a job)
chunkSeq - the chunk's sequence (null outside a job)
rowKey - the row the effect is for (caller-chosen, stable)
payload - the effect's data (small values)
payloadRef - a reference to a larger stored payload, or null
attempt - 1 for the first delivery attempt
public record EffectRequest(String idempotencyKey, String effectName, JobEffectType effectType, Integer jobId, Integer chunkSeq, String rowKey, Map<String,Serializable> payload, String payloadRef, int attempt) extends Record
One effect, as handed to its target for delivery or reconciliation.

  • Constructor Details

    • EffectRequest

      public EffectRequest(String idempotencyKey, String effectName, JobEffectType effectType, Integer jobId, Integer chunkSeq, String rowKey, Map<String,Serializable> payload, String payloadRef, int attempt)
      Creates an instance of a EffectRequest record class.
      Parameters:
      idempotencyKey - the value for the idempotencyKey record component
      effectName - the value for the effectName record component
      effectType - the value for the effectType record component
      jobId - the value for the jobId record component
      chunkSeq - the value for the chunkSeq 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
      attempt - the value for the attempt 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 the compare method from their corresponding wrapper classes.
      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.

    • idempotencyKey

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

    • effectName

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

    • effectType

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

    • jobId

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

    • chunkSeq

      public Integer chunkSeq()
      Returns the value of the chunkSeq record component.
      Returns:
      the value of the chunkSeq 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

    • attempt

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