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 Summary

Modifier and Type	Method and Description
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder	accessKey(String accessKey) Access key for the associated azure account name to be used for authentication with azure queue services.
default QueueEndpointBuilderFactory.AdvancedQueueEndpointConsumerBuilder	advanced()
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder	autoDiscoverClient(boolean autoDiscoverClient) Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder	autoDiscoverClient(String autoDiscoverClient) Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.
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.
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.
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder	credentials(Object credentials) StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information.
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder	credentials(String credentials) StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information.
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.
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.
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder	messageId(String messageId) The ID of the message to be deleted or updated.
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder	popReceipt(String popReceipt) Unique identifier that must match for the message to be deleted or updated.
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder	serviceClient(Object serviceClient) Service client to a storage account to interact with the queue service.
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder	serviceClient(String serviceClient) Service client to a storage account to interact with the queue service.
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder	timeout(Duration timeout) An optional timeout applied to the operation.
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder	timeout(String timeout) An optional timeout applied to the operation.
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder	timeToLive(Duration timeToLive) How long the message will stay alive in the queue.
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder	timeToLive(String timeToLive) How long the message will stay alive in the queue.
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder	visibilityTimeout(Duration visibilityTimeout) The timeout period for how long the message is invisible in the queue.
default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder	visibilityTimeout(String visibilityTimeout) The timeout period for how long the message is invisible in the queue.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

advanced

default QueueEndpointBuilderFactory.AdvancedQueueEndpointConsumerBuilder advanced()

autoDiscoverClient

default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder autoDiscoverClient(boolean autoDiscoverClient)

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. The option is a: <code>boolean</code> type. Default: true Group: common

Parameters:

autoDiscoverClient - the value to set

Returns:

the dsl builder

autoDiscoverClient

default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder autoDiscoverClient(String autoDiscoverClient)

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Parameters:

autoDiscoverClient - the value to set

Returns:

the dsl builder

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: <code>com.azure.storage.queue.QueueServiceClient</code> type. Group: common

Parameters:

serviceClient - the value to set

Returns:

the dsl builder

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 <code>com.azure.storage.queue.QueueServiceClient</code> type. Group: common

Parameters:

serviceClient - the value to set

Returns:

the dsl builder

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: <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

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 <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

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: <code>java.lang.Integer</code> type. Default: 1 Group: queue

Parameters:

maxMessages - the value to set

Returns:

the dsl builder

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 <code>java.lang.Integer</code> type. Default: 1 Group: queue

Parameters:

maxMessages - the value to set

Returns:

the dsl builder

messageId

default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder messageId(String messageId)

The ID of the message to be deleted or updated. The option is a: <code>java.lang.String</code> type. Group: queue

Parameters:

messageId - the value to set

Returns:

the dsl builder

popReceipt

default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder popReceipt(String popReceipt)

Unique identifier that must match for the message to be deleted or updated. The option is a: <code>java.lang.String</code> type. Group: queue

Parameters:

popReceipt - the value to set

Returns:

the dsl builder

timeout

default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder timeout(Duration 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 is a: <code>java.time.Duration</code> type. Group: queue

Parameters:

timeout - the value to set

Returns:

the dsl builder

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 <code>java.time.Duration</code> type. Group: queue

Parameters:

timeout - the value to set

Returns:

the dsl builder

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: <code>java.time.Duration</code> type. Group: queue

Parameters:

timeToLive - the value to set

Returns:

the dsl builder

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 <code>java.time.Duration</code> type. Group: queue

Parameters:

timeToLive - the value to set

Returns:

the dsl builder

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: <code>java.time.Duration</code> type. Group: queue

Parameters:

visibilityTimeout - the value to set

Returns:

the dsl builder

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 <code>java.time.Duration</code> type. Group: queue

Parameters:

visibilityTimeout - the value to set

Returns:

the dsl builder

accessKey

default QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder accessKey(String accessKey)

Access key for the associated azure account name to be used for authentication with azure queue services. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

accessKey - the value to set

Returns:

the dsl builder

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: <code>com.azure.storage.common.StorageSharedKeyCredential</code> type. Group: security

Parameters:

credentials - the value to set

Returns:

the dsl builder

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 <code>com.azure.storage.common.StorageSharedKeyCredential</code> type. Group: security

Parameters:

credentials - the value to set

Returns:

the dsl builder