Package io.axoniq.framework.workflow.dsl.api

Record Class PayloadStepDefinition

java.lang.Object
java.lang.Record
io.axoniq.framework.workflow.dsl.api.PayloadStepDefinition
Record Components:
primitiveMetadata - metadata of the primitive
modification - payload modification
public record PayloadStepDefinition(PrimitiveMetadata primitiveMetadata, PayloadModification modification) extends Record
Specification for modifying of payload within a workflow.
Since:
5.4.0
Author:
Simon Zambrovski

  • Constructor Details

    • PayloadStepDefinition

      public PayloadStepDefinition(PrimitiveMetadata primitiveMetadata, PayloadModification modification)
      Creates an instance of a PayloadStepDefinition record class.
      Parameters:
      primitiveMetadata - the value for the primitiveMetadata record component
      modification - the value for the modification record component

  • Method Details

    • primitiveMetadata

      public PayloadStepDefinition primitiveMetadata(PrimitiveMetadata primitiveMetadata)
      Returns a copy of this definition with the provided primitive metadata.
      Parameters:
      primitiveMetadata - metadata of the primitive
      Returns:
      copied step definition with updated metadata

    • stepName

      public PayloadStepDefinition stepName(String stepName)
      Returns a copy of this definition with the provided step name.
      Parameters:
      stepName - logical step name
      Returns:
      copied step definition with updated step name

    • eventNameCustomizer

      public PayloadStepDefinition eventNameCustomizer(EventNameCustomizer eventNameCustomizer)
      Returns a copy of this definition with the provided event name customizer.
      Parameters:
      eventNameCustomizer - customizer for published event names
      Returns:
      copied step definition with updated event naming

    • modification

      public PayloadStepDefinition modification(PayloadModification modification)
      Returns a copy of this definition with the provided payload modification.
      Parameters:
      modification - payload modification
      Returns:
      copied step definition with updated payload modification

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

    • primitiveMetadata

      public PrimitiveMetadata primitiveMetadata()
      Returns the value of the primitiveMetadata record component.
      Returns:
      the value of the primitiveMetadata record component

    • modification

      public PayloadModification modification()
      Returns the value of the modification record component.
      Returns:
      the value of the modification record component