Class EventHubsEndpointBuilderFactory.EventHubsHeaderNameBuilder
- java.lang.Object
-
- org.apache.camel.builder.endpoint.dsl.EventHubsEndpointBuilderFactory.EventHubsHeaderNameBuilder
-
- Enclosing interface:
- EventHubsEndpointBuilderFactory
public static class EventHubsEndpointBuilderFactory.EventHubsHeaderNameBuilder extends Object
The builder of headers' name for the Azure Event Hubs component.
-
-
Constructor Summary
Constructors Constructor Description EventHubsHeaderNameBuilder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
azureEventHubsCheckpointUpdatedBy()
It sets the reason for the checkpoint to have been updated.String
azureEventHubsEnqueuedTime()
It sets the instant, in UTC, of when the event was enqueued in the Event Hub partition.String
azureEventHubsMetadata()
The set of free-form event properties which may be used for passing metadata associated with the event with the event body during Event Hubs operations.String
azureEventHubsOffset()
It sets the offset of the event when it was received from the associated Event Hub partition.String
azureEventHubsPartitionId()
(producer) Overrides the identifier of the Event Hub partition that the events will be sent to.String
azureEventHubsPartitionKey()
(producer) Overrides the hashing key to be provided for the batch of events, which instructs the Event Hubs service to map this key to a specific partition.String
azureEventHubsSequenceNumber()
It sets the sequence number assigned to the event when it was enqueued in the associated Event Hub partition.String
messageTimestamp()
The timestamp of the message.
-
-
-
Method Detail
-
azureEventHubsPartitionKey
public String azureEventHubsPartitionKey()
(producer) Overrides the hashing key to be provided for the batch of events, which instructs the Event Hubs service to map this key to a specific partition. (consumer) It sets the partition hashing key if it was set when originally publishing the event. If it exists, this value was used to compute a hash to select a partition to send the message to. This is only present on a received EventData. The option is a:String
type. Group: common- Returns:
- the name of the header
AzureEventHubsPartitionKey
.
-
azureEventHubsPartitionId
public String azureEventHubsPartitionId()
(producer) Overrides the identifier of the Event Hub partition that the events will be sent to. (consumer) It sets the partition id of the Event Hub. The option is a:String
type. Group: common- Returns:
- the name of the header
AzureEventHubsPartitionId
.
-
azureEventHubsOffset
public String azureEventHubsOffset()
It sets the offset of the event when it was received from the associated Event Hub partition. This is only present on a received EventData. The option is a:Integer
type. Group: consumer- Returns:
- the name of the header
AzureEventHubsOffset
.
-
azureEventHubsEnqueuedTime
public String azureEventHubsEnqueuedTime()
It sets the instant, in UTC, of when the event was enqueued in the Event Hub partition. This is only present on a received EventData. The option is a:Instant
type. Group: consumer- Returns:
- the name of the header
AzureEventHubsEnqueuedTime
.
-
azureEventHubsSequenceNumber
public String azureEventHubsSequenceNumber()
It sets the sequence number assigned to the event when it was enqueued in the associated Event Hub partition. This is unique for every message received in the Event Hub partition. This is only present on a received EventData. The option is a:Long
type. Group: consumer- Returns:
- the name of the header
AzureEventHubsSequenceNumber
.
-
azureEventHubsMetadata
public String azureEventHubsMetadata()
The set of free-form event properties which may be used for passing metadata associated with the event with the event body during Event Hubs operations. The option is a:Map<String, Object>
type. Group: consumer- Returns:
- the name of the header
AzureEventHubsMetadata
.
-
messageTimestamp
public String messageTimestamp()
The timestamp of the message. The option is a:long
type. Group: consumer- Returns:
- the name of the header
MessageTimestamp
.
-
azureEventHubsCheckpointUpdatedBy
public String azureEventHubsCheckpointUpdatedBy()
It sets the reason for the checkpoint to have been updated. This is only present on a received EventData. The option is a:String
type. Group: consumer- Returns:
- the name of the header
AzureEventHubsCheckpointUpdatedBy
.
-
-