Package org.apache.camel.builder.endpoint.dsl

Class KafkaEndpointBuilderFactory.KafkaHeaderNameBuilder

  • Enclosing interface:
    KafkaEndpointBuilderFactory
    public static class KafkaEndpointBuilderFactory.KafkaHeaderNameBuilder
extends Object
    The builder of headers' name for the Kafka component.

    • Constructor Detail

      • KafkaHeaderNameBuilder

        public KafkaHeaderNameBuilder()

    • Method Detail

      • kafkaPartitionKey

        public String kafkaPartitionKey()
        Explicitly specify the partition. The option is a: Integer type. Group: producer
        Returns:
        the name of the header kafka.PARTITION_KEY.

      • kafkaPartition

        public String kafkaPartition()
        The partition where the message was stored. The option is a: Integer type. Group: consumer
        Returns:
        the name of the header kafka.PARTITION.

      • kafkaKey

        public String kafkaKey()
        Producer: The key of the message in order to ensure that all related message goes in the same partition. Consumer: The key of the message if configured. The option is a: Object type. Required: true Group: common
        Returns:
        the name of the header kafka.KEY.

      • kafkaTopic

        public String kafkaTopic()
        The topic from where the message originated. The option is a: String type. Group: consumer
        Returns:
        the name of the header kafka.TOPIC.

      • kafkaOverrideTopic

        public String kafkaOverrideTopic()
        The topic to which send the message (override and takes precedence), and the header is not preserved. The option is a: String type. Group: producer
        Returns:
        the name of the header kafka.OVERRIDE_TOPIC.

      • kafkaOffset

        public String kafkaOffset()
        The offset of the message. The option is a: Long type. Group: consumer
        Returns:
        the name of the header kafka.OFFSET.

      • kafkaHeaders

        public String kafkaHeaders()
        The record headers. The option is a: org.apache.kafka.common.header.Headers type. Group: consumer
        Returns:
        the name of the header kafka.HEADERS.

      • kafkaLastRecordBeforeCommit

        public String kafkaLastRecordBeforeCommit()
        Whether or not it's the last record before commit (only available if autoCommitEnable endpoint parameter is false). The option is a: Boolean type. Group: consumer
        Returns:
        the name of the header kafka.LAST_RECORD_BEFORE_COMMIT.

      • kafkaLastPollRecord

        public String kafkaLastPollRecord()
        Indicates the last record within the current poll request (only available if autoCommitEnable endpoint parameter is false or allowManualCommit is true). The option is a: Boolean type. Group: consumer
        Returns:
        the name of the header kafka.LAST_POLL_RECORD.

      • kafkaTimestamp

        public String kafkaTimestamp()
        The timestamp of the message. The option is a: Long type. Group: consumer
        Returns:
        the name of the header kafka.TIMESTAMP.

      • kafkaOverrideTimestamp

        public String kafkaOverrideTimestamp()
        The ProducerRecord also has an associated timestamp. If the user did provide a timestamp, the producer will stamp the record with the provided timestamp and the header is not preserved. The option is a: Long type. Group: producer
        Returns:
        the name of the header kafka.OVERRIDE_TIMESTAMP.

      • orgApacheKafkaClientsProducerRecordmetadata

        public String orgApacheKafkaClientsProducerRecordmetadata()
        The metadata (only configured if recordMetadata endpoint parameter is true). The option is a: List<RecordMetadata> type. Group: producer
        Returns:
        the name of the header org.apache.kafka.clients.producer.RecordMetadata.

      • kafkaManualCommit

        public String kafkaManualCommit()
        Can be used for forcing manual offset commit when using Kafka consumer. The option is a: org.apache.camel.component.kafka.consumer.KafkaManualCommit type. Group: consumer
        Returns:
        the name of the header KafkaManualCommit.