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

Interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    QueueEndpointBuilderFactory.QueueEndpointBuilder
    Enclosing interface:
    QueueEndpointBuilderFactory
    public static interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the Azure Storage Queue Service component.

    • Method Detail

      • serviceClient

        default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder serviceClient​(Object serviceClient)
        Service client to a storage account to interact with the queue service. This client does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. This client contains all the operations for interacting with a queue account in Azure Storage. Operations allowed by the client are creating, listing, and deleting queues, retrieving and updating properties of the account, and retrieving statistics of the account. The option is a: com.azure.storage.queue.QueueServiceClient type. Group: common

      • serviceClient

        default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder serviceClient​(String serviceClient)
        Service client to a storage account to interact with the queue service. This client does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. This client contains all the operations for interacting with a queue account in Azure Storage. Operations allowed by the client are creating, listing, and deleting queues, retrieving and updating properties of the account, and retrieving statistics of the account. The option will be converted to a com.azure.storage.queue.QueueServiceClient type. Group: common

      • bridgeErrorHandler

        default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder bridgeErrorHandler​(boolean bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: boolean type. Default: false Group: consumer

      • bridgeErrorHandler

        default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder bridgeErrorHandler​(String bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a boolean type. Default: false Group: consumer

      • maxMessages

        default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder maxMessages​(Integer maxMessages)
        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: java.lang.Integer type. Default: 1 Group: queue

      • maxMessages

        default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder maxMessages​(String maxMessages)
        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 will be converted to a java.lang.Integer type. Default: 1 Group: queue

      • timeout

        default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder timeout​(String timeout)
        An optional timeout applied to the operation. If a response is not returned before the timeout concludes a RuntimeException will be thrown. The option will be converted to a java.time.Duration type. Group: queue

      • timeToLive

        default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder timeToLive​(Duration timeToLive)
        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 format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S -- parses as 20.345 seconds, P2D -- parses as 2 days However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe. The option is a: java.time.Duration type. Group: queue

      • timeToLive

        default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder timeToLive​(String timeToLive)
        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 format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S -- parses as 20.345 seconds, P2D -- parses as 2 days However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe. The option will be converted to a java.time.Duration type. Group: queue

      • visibilityTimeout

        default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder visibilityTimeout​(Duration visibilityTimeout)
        The timeout period for how long the message is invisible in the queue. The timeout must be between 1 seconds and 7 days. The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S -- parses as 20.345 seconds, P2D -- parses as 2 days However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe. The option is a: java.time.Duration type. Group: queue

      • visibilityTimeout

        default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder visibilityTimeout​(String visibilityTimeout)
        The timeout period for how long the message is invisible in the queue. The timeout must be between 1 seconds and 7 days. The format should be in this form: PnDTnHnMn.nS., e.g: PT20.345S -- parses as 20.345 seconds, P2D -- parses as 2 days However, in case you are using EndpointDsl/ComponentDsl, you can do something like Duration.ofSeconds() since these Java APIs are typesafe. The option will be converted to a java.time.Duration type. Group: queue

      • credentials

        default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder credentials​(Object credentials)
        StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information. The option is a: com.azure.storage.common.StorageSharedKeyCredential type. Group: security

      • credentials

        default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder credentials​(String credentials)
        StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information. The option will be converted to a com.azure.storage.common.StorageSharedKeyCredential type. Group: security