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

Class QueueEndpointBuilderFactory.QueueHeaderNameBuilder

  • Enclosing interface:
    QueueEndpointBuilderFactory
    public static class QueueEndpointBuilderFactory.QueueHeaderNameBuilder
extends Object
    The builder of headers' name for the Azure Storage Queue Service component.

    • Constructor Detail

      • QueueHeaderNameBuilder

        public QueueHeaderNameBuilder()

    • Method Detail

      • azureStorageQueueRawHttpHeaders

        public String azureStorageQueueRawHttpHeaders()
        Returns non-parsed httpHeaders that can be used by the user. The option is a: HttpHeaders type. Group: common
        Returns:
        the name of the header AzureStorageQueueRawHttpHeaders.

      • azureStorageQueueMetadata

        public String azureStorageQueueMetadata()
        (createQueue) Metadata to associate with the queue. The option is a: Map<String,String> type. Group: producer
        Returns:
        the name of the header AzureStorageQueueMetadata.

      • azureStorageQueueMessageId

        public String azureStorageQueueMessageId()
        The ID of the message. The option is a: String type. Group: common
        Returns:
        the name of the header AzureStorageQueueMessageId.

      • azureStorageQueueInsertionTime

        public String azureStorageQueueInsertionTime()
        The time the Message was inserted into the Queue. The option is a: OffsetDateTime type. Group: common
        Returns:
        the name of the header AzureStorageQueueInsertionTime.

      • azureStorageQueueExpirationTime

        public String azureStorageQueueExpirationTime()
        The time that the Message will expire and be automatically deleted. The option is a: OffsetDateTime type. Group: common
        Returns:
        the name of the header AzureStorageQueueExpirationTime.

      • azureStorageQueuePopReceipt

        public String azureStorageQueuePopReceipt()
        (deleteMessage, updateMessage) Unique identifier that must match for the message to be deleted or updated. If deletion fails using this pop receipt then the message has been dequeued by another client. The option is a: String type. Group: producer
        Returns:
        the name of the header AzureStorageQueuePopReceipt.

      • azureStorageQueueTimeNextVisible

        public String azureStorageQueueTimeNextVisible()
        The time that the message will again become visible in the Queue. The option is a: OffsetDateTime type. Group: common
        Returns:
        the name of the header AzureStorageQueueTimeNextVisible.

      • azureStorageQueueDequeueCount

        public String azureStorageQueueDequeueCount()
        The number of times the message has been dequeued. The option is a: long type. Group: common
        Returns:
        the name of the header AzureStorageQueueDequeueCount.

      • azureStorageQueueOperation

        public String azureStorageQueueOperation()
        (All) Specify the producer operation to execute, please see the doc on this page related to producer operation. The option is a: org.apache.camel.component.azure.storage.queue.QueueOperationDefinition type. Group: producer
        Returns:
        the name of the header AzureStorageQueueOperation.

      • azureStorageQueueName

        public String azureStorageQueueName()
        (All) Override the queue name. The option is a: String type. Group: producer
        Returns:
        the name of the header AzureStorageQueueName.

      • azureStorageQueueSegmentOptions

        public String azureStorageQueueSegmentOptions()
        (listQueues) Options for listing queues. The option is a: QueuesSegmentOptions type. Group: producer
        Returns:
        the name of the header AzureStorageQueueSegmentOptions.

      • azureStorageQueueTimeout

        public String azureStorageQueueTimeout()
        (All) An optional timeout value beyond which a RuntimeException will be raised. The option is a: Duration type. Group: producer
        Returns:
        the name of the header AzureStorageQueueTimeout.

      • azureStorageQueueMaxMessages

        public String azureStorageQueueMaxMessages()
        (receiveMessages, peekMessages) Maximum number of messages to get, if there are less messages exist in the queue than requested all the messages will be returned. If left empty only 1 message will be retrieved, the allowed range is 1 to 32 messages. The option is a: Integer type. Group: producer
        Returns:
        the name of the header AzureStorageQueueMaxMessages.

      • azureStorageQueueVisibilityTimeout

        public String azureStorageQueueVisibilityTimeout()
        (sendMessage, receiveMessages, updateMessage) The timeout period for how long the message is invisible in the queue. If unset the value will default to 0 and the message will be instantly visible. The timeout must be between 0 seconds and 7 days. The option is a: Duration type. Group: producer
        Returns:
        the name of the header AzureStorageQueueVisibilityTimeout.

      • azureStorageQueueTimeToLive

        public String azureStorageQueueTimeToLive()
        (sendMessage) How long the message will stay alive in the queue. If unset the value will default to 7 days, if -1 is passed the message will not expire. The time to live must be -1 or any positive number. The option is a: Duration type. Group: producer
        Returns:
        the name of the header AzureStorageQueueTimeToLive.

      • azureStorageQueueCreateQueue

        public String azureStorageQueueCreateQueue()
        (sendMessage) When is set to true, the queue will be automatically created when sending messages to the queue. The option is a: boolean type. Group: producer
        Returns:
        the name of the header AzureStorageQueueCreateQueue.