Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data Processor = Processor' {}
- newProcessor :: Text -> ProcessorConfiguration -> Natural -> FallbackAction -> Processor
- processor_name :: Lens' Processor Text
- processor_configuration :: Lens' Processor ProcessorConfiguration
- processor_executionOrder :: Lens' Processor Natural
- processor_fallbackAction :: Lens' Processor FallbackAction
Documentation
The information about a processor in a channel flow.
See: newProcessor
smart constructor.
Processor' | |
|
Instances
:: Text | |
-> ProcessorConfiguration | |
-> Natural | |
-> FallbackAction | |
-> Processor |
Create a value of Processor
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Processor'
, processor_name
- The name of the channel flow.
$sel:configuration:Processor'
, processor_configuration
- The information about the type of processor and its identifier.
$sel:executionOrder:Processor'
, processor_executionOrder
- The sequence in which processors run. If you have multiple processors in
a channel flow, message processing goes through each processor in the
sequence. The value determines the sequence. At this point, we support
only 1 processor within a flow.
$sel:fallbackAction:Processor'
, processor_fallbackAction
- Determines whether to continue with message processing or stop it in
cases where communication with a processor fails. If a processor has a
fallback action of ABORT
and communication with it fails, the
processor sets the message status to FAILED
and does not send the
message to any recipients. Note that if the last processor in the
channel flow sequence has a fallback action of CONTINUE
and
communication with the processor fails, then the message is considered
processed and sent to recipients of the channel.
processor_configuration :: Lens' Processor ProcessorConfiguration Source #
The information about the type of processor and its identifier.
processor_executionOrder :: Lens' Processor Natural Source #
The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.
processor_fallbackAction :: Lens' Processor FallbackAction Source #
Determines whether to continue with message processing or stop it in
cases where communication with a processor fails. If a processor has a
fallback action of ABORT
and communication with it fails, the
processor sets the message status to FAILED
and does not send the
message to any recipients. Note that if the last processor in the
channel flow sequence has a fallback action of CONTINUE
and
communication with the processor fails, then the message is considered
processed and sent to recipients of the channel.