Uses of Record Class
io.axoniq.framework.workflow.dsl.api.PayloadStepDefinition

Packages that use PayloadStepDefinition

Package	Description
io.axoniq.framework.workflow.dsl.api
io.axoniq.framework.workflow.dsl.base	Base Java DSL for defining workflow steps, providing the core primitives to execute work, wait for events, modify the workflow payload, sleep, fail, and cancel a workflow.
io.axoniq.framework.workflow.runtime.execution	Internal implementation of the workflow execution engine: the WorkflowEngine, its scheduling, state and storage, checkpointing/replay support, cancellation coordination, and the delegates implementing individual step primitives.

Uses of PayloadStepDefinition in io.axoniq.framework.workflow.dsl.api

Methods in io.axoniq.framework.workflow.dsl.api that return PayloadStepDefinition

Modifier and Type	Method	Description
PayloadStepDefinition	PayloadStepDefinition.eventNameCustomizer(EventNameCustomizer eventNameCustomizer)	Returns a copy of this definition with the provided event name customizer.
PayloadStepDefinition	PayloadStepDefinition.modification(PayloadModification modification)	Returns a copy of this definition with the provided payload modification.
PayloadStepDefinition	PayloadStepDefinition.primitiveMetadata(PrimitiveMetadata primitiveMetadata)	Returns a copy of this definition with the provided primitive metadata.
PayloadStepDefinition	PayloadStepDefinition.stepName(String stepName)	Returns a copy of this definition with the provided step name.

Methods in io.axoniq.framework.workflow.dsl.api with parameters of type PayloadStepDefinition

Modifier and Type	Method	Description
void	WorkflowContext.awaitModifyPayload(PayloadStepDefinition stepDefinition)	Applies a payload modification from a DSL step definition and blocks until it completes.
WorkflowStepResult	WorkflowContext.modifyPayload(PayloadStepDefinition stepDefinition)	Applies a payload modification asynchronously from a DSL step definition.

Uses of PayloadStepDefinition in io.axoniq.framework.workflow.dsl.base

Methods in io.axoniq.framework.workflow.dsl.base that return PayloadStepDefinition

Modifier and Type	Method	Description
PayloadStepDefinition	BaseWorkflowContext.defaultPayloadStepDefinition(String stepName, PayloadModification modification)	Creates the default payload modification step definition used by the convenience overloads in this class.

Method parameters in io.axoniq.framework.workflow.dsl.base with type arguments of type PayloadStepDefinition

Modifier and Type	Method	Description
void	BaseWorkflowContext.awaitModifyPayload(String stepName, PayloadModification modification, UnaryOperator<PayloadStepDefinition> customizer)	Updates the workflow payload and blocks until the change has been applied.
WorkflowStepResult	BaseWorkflowContext.modifyPayload(String stepName, PayloadModification modification, UnaryOperator<PayloadStepDefinition> customizer)	Starts a step that updates the workflow payload.

Uses of PayloadStepDefinition in io.axoniq.framework.workflow.runtime.execution

Methods in io.axoniq.framework.workflow.runtime.execution with parameters of type PayloadStepDefinition

Modifier and Type	Method	Description
void	AbstractWorkflowContext.awaitModifyPayload(PayloadStepDefinition stepDefinition)
WorkflowStepResult	AbstractWorkflowContext.modifyPayload(PayloadStepDefinition stepDefinition)