minos.saga.definitions.steps.local
Classes
Local Saga Step class. |
- class LocalSagaStep[source]
Bases:
SagaStepLocal Saga Step class.
- __init__(on_execute=None, on_failure=None, **kwargs)[source]
- Parameters
on_execute (Optional[Union[Callable[[SagaContext, ...], Union[SagaContext, None, Awaitable[Optional[SagaContext]]]], SagaOperation[Callable[[SagaContext, ...], Union[SagaContext, None, Awaitable[Optional[SagaContext]]]]]]]) –
on_failure (Optional[Union[Callable[[SagaContext, ...], Union[SagaContext, None, Awaitable[Optional[SagaContext]]]], SagaOperation[Callable[[SagaContext, ...], Union[SagaContext, None, Awaitable[Optional[SagaContext]]]]]]]) –
- on_execute(callback, parameters=None, **kwargs)[source]
On execute method.
- Parameters
callback (Callable[[SagaContext, ...], Union[SagaContext, None, Awaitable[Optional[SagaContext]]]]) – The callback function to be called.
parameters (Optional[SagaContext]) – A mapping of named parameters to be passed to the callback.
kwargs – A set of named arguments to be passed to the callback.
parametershas priority if it is notNone.
- Returns
A
selfreference.- Return type
- on_failure(callback, parameters=None, **kwargs)[source]
On failure method.
- Parameters
callback (Callable[[SagaContext, ...], Union[SagaContext, None, Awaitable[Optional[SagaContext]]]]) – The callback function to be called.
parameters (Optional[SagaContext]) – A mapping of named parameters to be passed to the callback.
kwargs – A set of named arguments to be passed to the callback.
parametershas priority if it is notNone.
- Returns
A
selfreference.- Return type
- validate()[source]
Check if the step is valid.
- Returns
This method does not return anything, but raises an exception if the step is not valid.
- Return type
None
- property raw: dict[str, Any]
Generate a raw representation of the instance.
- Returns
A
dictinstance.
- commit(*args, **kwargs)
Commit the current
SagaStepon theSaga.- Parameters
args – Additional positional arguments.
kwargs – Additional named arguments.
- Returns
A
Sagainstance.- Return type
- conditional_step(*args, **kwargs)
Create a new conditional step in the
Saga.- Parameters
args – Additional positional parameters.
kwargs – Additional named parameters.
- Returns
A new
SagaStepinstance.- Return type
- classmethod from_raw(raw, **kwargs)
Build a new instance from raw.
- local_step(*args, **kwargs)
Create a new local step in the
Saga.- Parameters
args – Additional positional parameters.
kwargs – Additional named parameters.
- Returns
A new
SagaStepinstance.- Return type
- remote_step(*args, **kwargs)
Create a new remote step in the
Saga.- Parameters
args – Additional positional parameters.
kwargs – Additional named parameters.
- Returns
A new
SagaStepinstance.- Return type