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 TypeMethodDescriptionAccess key for the associated azure account name to be used for authentication with azure queue services.advanced()
credentials
(com.azure.storage.common.StorageSharedKeyCredential credentials) StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information.credentials
(String credentials) StorageSharedKeyCredential can be injected to create the azure client, this holds the important authentication information.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.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.The ID of the message to be deleted or updated.popReceipt
(String popReceipt) Unique identifier that must match for the message to be deleted or updated.serviceClient
(com.azure.storage.queue.QueueServiceClient serviceClient) Service client to a storage account to interact with the queue service.serviceClient
(String serviceClient) Service client to a storage account to interact with the queue service.An optional timeout applied to the operation.An optional timeout applied to the operation.timeToLive
(String timeToLive) How long the message will stay alive in the queue.timeToLive
(Duration timeToLive) How long the message will stay alive in the queue.visibilityTimeout
(String visibilityTimeout) The timeout period for how long the message is invisible in the queue.visibilityTimeout
(Duration 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, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.QueueEndpointBuilderFactory.QueueEndpointConsumerBuilder
backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, delay, delay, greedy, greedy, initialDelay, initialDelay, repeatCount, repeatCount, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, startScheduler, startScheduler, timeUnit, timeUnit, useFixedDelay, useFixedDelay
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.QueueEndpointBuilderFactory.QueueEndpointProducerBuilder
createQueue, createQueue, operation, operation
-
Method Details
-
advanced
- Specified by:
advanced
in interfaceQueueEndpointBuilderFactory.QueueEndpointConsumerBuilder
- Specified by:
advanced
in interfaceQueueEndpointBuilderFactory.QueueEndpointProducerBuilder
-
serviceClient
default QueueEndpointBuilderFactory.QueueEndpointBuilder serviceClient(com.azure.storage.queue.QueueServiceClient 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- Specified by:
serviceClient
in interfaceQueueEndpointBuilderFactory.QueueEndpointConsumerBuilder
- Specified by:
serviceClient
in interfaceQueueEndpointBuilderFactory.QueueEndpointProducerBuilder
- Parameters:
serviceClient
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
serviceClient
in interfaceQueueEndpointBuilderFactory.QueueEndpointConsumerBuilder
- Specified by:
serviceClient
in interfaceQueueEndpointBuilderFactory.QueueEndpointProducerBuilder
- Parameters:
serviceClient
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
maxMessages
in interfaceQueueEndpointBuilderFactory.QueueEndpointConsumerBuilder
- Specified by:
maxMessages
in interfaceQueueEndpointBuilderFactory.QueueEndpointProducerBuilder
- Parameters:
maxMessages
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
maxMessages
in interfaceQueueEndpointBuilderFactory.QueueEndpointConsumerBuilder
- Specified by:
maxMessages
in interfaceQueueEndpointBuilderFactory.QueueEndpointProducerBuilder
- Parameters:
maxMessages
- the value to set- Returns:
- the dsl builder
-
messageId
The ID of the message to be deleted or updated. The option is a: <code>java.lang.String</code> type. Group: queue- Specified by:
messageId
in interfaceQueueEndpointBuilderFactory.QueueEndpointConsumerBuilder
- Specified by:
messageId
in interfaceQueueEndpointBuilderFactory.QueueEndpointProducerBuilder
- Parameters:
messageId
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
popReceipt
in interfaceQueueEndpointBuilderFactory.QueueEndpointConsumerBuilder
- Specified by:
popReceipt
in interfaceQueueEndpointBuilderFactory.QueueEndpointProducerBuilder
- Parameters:
popReceipt
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
timeout
in interfaceQueueEndpointBuilderFactory.QueueEndpointConsumerBuilder
- Specified by:
timeout
in interfaceQueueEndpointBuilderFactory.QueueEndpointProducerBuilder
- Parameters:
timeout
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
timeout
in interfaceQueueEndpointBuilderFactory.QueueEndpointConsumerBuilder
- Specified by:
timeout
in interfaceQueueEndpointBuilderFactory.QueueEndpointProducerBuilder
- Parameters:
timeout
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
timeToLive
in interfaceQueueEndpointBuilderFactory.QueueEndpointConsumerBuilder
- Specified by:
timeToLive
in interfaceQueueEndpointBuilderFactory.QueueEndpointProducerBuilder
- Parameters:
timeToLive
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
timeToLive
in interfaceQueueEndpointBuilderFactory.QueueEndpointConsumerBuilder
- Specified by:
timeToLive
in interfaceQueueEndpointBuilderFactory.QueueEndpointProducerBuilder
- Parameters:
timeToLive
- the value to set- Returns:
- the dsl builder
-
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: <code>java.time.Duration</code> type. Group: queue- Specified by:
visibilityTimeout
in interfaceQueueEndpointBuilderFactory.QueueEndpointConsumerBuilder
- Specified by:
visibilityTimeout
in interfaceQueueEndpointBuilderFactory.QueueEndpointProducerBuilder
- Parameters:
visibilityTimeout
- the value to set- Returns:
- the dsl builder
-
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 <code>java.time.Duration</code> type. Group: queue- Specified by:
visibilityTimeout
in interfaceQueueEndpointBuilderFactory.QueueEndpointConsumerBuilder
- Specified by:
visibilityTimeout
in interfaceQueueEndpointBuilderFactory.QueueEndpointProducerBuilder
- Parameters:
visibilityTimeout
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
accessKey
in interfaceQueueEndpointBuilderFactory.QueueEndpointConsumerBuilder
- Specified by:
accessKey
in interfaceQueueEndpointBuilderFactory.QueueEndpointProducerBuilder
- Parameters:
accessKey
- the value to set- Returns:
- the dsl builder
-
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- Specified by:
credentials
in interfaceQueueEndpointBuilderFactory.QueueEndpointConsumerBuilder
- Specified by:
credentials
in interfaceQueueEndpointBuilderFactory.QueueEndpointProducerBuilder
- Parameters:
credentials
- the value to set- Returns:
- the dsl builder
-