sendToEventHubs

Processor that acts as an Event Hubs producer to publish data to a given Azure Event Hubs instance.

This processor has it own redelivery mechanism controlled by the processor specific properties:

  • sendTimeoutInSeconds

  • mode

  • delayBetweenRedeliveryAttemptsInSeconds

  • maxRedeliveryAttempts

  • maxDelayInSeconds

By default, maxRedeliveryAttempts is set to zero (processor specific redelivery disabled). If you want to enable processor specific redelivery, set maxRedeliveryAttempts to a value greater than zero. Be aware that, when enabling processor specific redelivery, you must ensure that the processor specific redelivery cycle (timeouts, delays and number of redeliveries) is shorter than the redeliveryMillis specified for the source redeliveryStrategy.

Properties

Name Summary

authenticationConfigKey

Key from the server configuration used to look up the credentials needed to connect to Azure Event Hubs.

partitionId

Optional partition ID, in case the message should be sent to a specific partition. If this is not set, messages could be sent to any partition. Should NOT be used together with partitionKey.

partitionKey

Optional partition key. If provided, all messages having the same partition key will be sent to the same partition. Should NOT be used together with partitionId.

sendTimeoutInSeconds

Optional send timeout. Sets the maximum duration to wait for completion of a single attempt, whether the initial attempt or a retry.

Defaults to 30 seconds.

Please see the processor documentation regarding use of this property and source specific redeliveryStrategy configuration.

mode

Optional retry mode. Defines if a constant (FIXED) or increasing (EXPONENTIAL) delay should be used between each retry.

Defaults to FIXED. That is, the same delay (delayBetweenRedeliveryAttemptsInSeconds) will be applied between each retry.

Please see the processor documentation regarding use of this property and source specific redeliveryStrategy configuration.

delayBetweenRedeliveryAttemptsInSeconds

Optional delay between retries. The delay between retry attempts for a fixed approach or the delay on which to base calculations for a backoff-approach.

Defaults to 10 seconds.

Please see the processor documentation regarding use of this property and source specific redeliveryStrategy configuration.

maxRedeliveryAttempts

Optional max delivery attempts. The maximum number of retry attempts before considering the associated operation to have failed.

Defaults to 0 (processor specific redelivery disabled).

Please see the processor documentation regarding use of this property and source specific redeliveryStrategy configuration.

maxDelayInSeconds

Optional max delay in seconds. The maximum permissible delay between retry attempts (when mode is set to EXPONENTIAL).

Defaults to 60 seconds.

Please see the processor documentation regarding use of this property and source specific redeliveryStrategy configuration.

forwardInput

Whether incoming payload should be passed to the output of the processor. Defaults to false (i.e., input is not forwarded to output).

name

Optional, descriptive name for the processor.

id

Required identifier of the processor, unique across all processors within the flow. Must be between 3 and 30 characters long; contain only lower and uppercase alphabetical characters (a-z and A-Z), numbers, dashes ("-"), and underscores ("_"); and start with an alphabetical character. In other words, it adheres to the regex pattern [a-zA-Z][a-zA-Z0-9_-]{2,29}.

exchangeProperties

Optional set of custom properties in a simple jdk-format, that are added to the message exchange properties before processing the incoming payload. Any existing properties with the same name will be replaced by properties defined here.

retainPayloadOnFailure

Whether the incoming payload is available for error processing on failure. Defaults to false.

Sub-builders

Name Summary

processingStrategy

Strategy for providing message processing hints to the server. Optional.

externalSystemDetails

Strategy for describing the external system integration. Optional.

circuitBreakerStrategy

Strategy for configuring the processor’s circuit breaker. Optional.

messageLoggingStrategy

Strategy for describing how a processor’s message is logged on the server.

payloadArchivingStrategy

Strategy for archiving payloads.

inboundTransformationStrategy

Strategy that customizes the conversion of an incoming payload by a processor (e.g., string to object). Should be used when the processor’s default conversion logic cannot be used.

Details

Authentication

The authenticationConfigKey property supports secrets of type AzureConnectionString. See the Secret Types documentation for formatting details.