org.apache.camel.builder.endpoint.dsl

Interface QueueEndpointBuilderFactory.QueueEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder, QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

Enclosing interface:

QueueEndpointBuilderFactory

public static interface QueueEndpointBuilderFactory.QueueEndpointBuilder
extends QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder, QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

Builder for endpoint for the Azure Storage Queue Service component.

Method Summary

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

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

bridgeErrorHandler, bridgeErrorHandler

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

createQueue, createQueue, lazyStartProducer, lazyStartProducer, operation, operation

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default QueueEndpointBuilderFactory.AdvancedQueueEndpointBuilder advanced()

Specified by:

advanced in interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Specified by:

advanced in interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

autoDiscoverClient

default QueueEndpointBuilderFactory.QueueEndpointBuilder 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: boolean type. Default: true Group: common

Specified by:

autoDiscoverClient in interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Specified by:

autoDiscoverClient in interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

autoDiscoverClient

default QueueEndpointBuilderFactory.QueueEndpointBuilder 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 boolean type. Default: true Group: common

Specified by:

autoDiscoverClient in interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Specified by:

autoDiscoverClient in interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

serviceClient

default QueueEndpointBuilderFactory.QueueEndpointBuilder 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

Specified by:

serviceClient in interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Specified by:

serviceClient in interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

serviceClient

default QueueEndpointBuilderFactory.QueueEndpointBuilder 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

Specified by:

serviceClient in interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Specified by:

serviceClient in interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

maxMessages

default QueueEndpointBuilderFactory.QueueEndpointBuilder 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

Specified by:

maxMessages in interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Specified by:

maxMessages in interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

maxMessages

default QueueEndpointBuilderFactory.QueueEndpointBuilder 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

Specified by:

maxMessages in interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Specified by:

maxMessages in interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

messageId

default QueueEndpointBuilderFactory.QueueEndpointBuilder messageId(String messageId)

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

Specified by:

messageId in interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Specified by:

messageId in interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

popReceipt

default QueueEndpointBuilderFactory.QueueEndpointBuilder popReceipt(String popReceipt)

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

Specified by:

popReceipt in interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Specified by:

popReceipt in interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

timeout

default QueueEndpointBuilderFactory.QueueEndpointBuilder 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: java.time.Duration type. Group: queue

Specified by:

timeout in interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Specified by:

timeout in interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

timeout

default QueueEndpointBuilderFactory.QueueEndpointBuilder 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

Specified by:

timeout in interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Specified by:

timeout in interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

timeToLive

default QueueEndpointBuilderFactory.QueueEndpointBuilder 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

Specified by:

timeToLive in interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Specified by:

timeToLive in interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

timeToLive

default QueueEndpointBuilderFactory.QueueEndpointBuilder 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

Specified by:

timeToLive in interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Specified by:

timeToLive in interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

visibilityTimeout

default QueueEndpointBuilderFactory.QueueEndpointBuilder 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

Specified by:

visibilityTimeout in interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Specified by:

visibilityTimeout in interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

visibilityTimeout

default QueueEndpointBuilderFactory.QueueEndpointBuilder 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

Specified by:

visibilityTimeout in interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Specified by:

visibilityTimeout in interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

accessKey

default QueueEndpointBuilderFactory.QueueEndpointBuilder accessKey(String accessKey)

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

Specified by:

accessKey in interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Specified by:

accessKey in interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

credentials

default QueueEndpointBuilderFactory.QueueEndpointBuilder 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

Specified by:

credentials in interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Specified by:

credentials in interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder

credentials

default QueueEndpointBuilderFactory.QueueEndpointBuilder 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

Specified by:

credentials in interface QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder

Specified by:

credentials in interface QueueEndpointBuilderFactory.QueueEndpointProducerBuilder