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

Interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
ServiceBusEndpointBuilderFactory.ServiceBusEndpointBuilder
Enclosing interface:
ServiceBusEndpointBuilderFactory
public static interface ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Azure ServiceBus component.

  • Method Details

    • advanced

      default ServiceBusEndpointBuilderFactory.AdvancedServiceBusEndpointConsumerBuilder advanced()

    • amqpRetryOptions

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder amqpRetryOptions(com.azure.core.amqp.AmqpRetryOptions amqpRetryOptions)
      Sets the retry options for Service Bus clients. If not specified, the default retry options are used. The option is a: com.azure.core.amqp.AmqpRetryOptions type. Group: common
      Parameters:
      amqpRetryOptions - the value to set
      Returns:
      the dsl builder

    • amqpRetryOptions

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder amqpRetryOptions(String amqpRetryOptions)
      Sets the retry options for Service Bus clients. If not specified, the default retry options are used. The option will be converted to a com.azure.core.amqp.AmqpRetryOptions type. Group: common
      Parameters:
      amqpRetryOptions - the value to set
      Returns:
      the dsl builder

    • amqpTransportType

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder amqpTransportType(com.azure.core.amqp.AmqpTransportType amqpTransportType)
      Sets the transport type by which all the communication with Azure Service Bus occurs. Default value is AMQP. The option is a: com.azure.core.amqp.AmqpTransportType type. Default: AMQP Group: common
      Parameters:
      amqpTransportType - the value to set
      Returns:
      the dsl builder

    • amqpTransportType

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder amqpTransportType(String amqpTransportType)
      Sets the transport type by which all the communication with Azure Service Bus occurs. Default value is AMQP. The option will be converted to a com.azure.core.amqp.AmqpTransportType type. Default: AMQP Group: common
      Parameters:
      amqpTransportType - the value to set
      Returns:
      the dsl builder

    • clientOptions

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)
      Sets the ClientOptions to be sent from the client built from this builder, enabling customization of certain properties, as well as support the addition of custom header information. The option is a: com.azure.core.util.ClientOptions type. Group: common
      Parameters:
      clientOptions - the value to set
      Returns:
      the dsl builder

    • clientOptions

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder clientOptions(String clientOptions)
      Sets the ClientOptions to be sent from the client built from this builder, enabling customization of certain properties, as well as support the addition of custom header information. The option will be converted to a com.azure.core.util.ClientOptions type. Group: common
      Parameters:
      clientOptions - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
      To use a custom HeaderFilterStrategy to filter Service Bus application properties to and from Camel message headers. The option is a: org.apache.camel.spi.HeaderFilterStrategy type. Group: common
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder headerFilterStrategy(String headerFilterStrategy)
      To use a custom HeaderFilterStrategy to filter Service Bus application properties to and from Camel message headers. The option will be converted to a org.apache.camel.spi.HeaderFilterStrategy type. Group: common
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • proxyOptions

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder proxyOptions(com.azure.core.amqp.ProxyOptions proxyOptions)
      Sets the proxy configuration to use for ServiceBusSenderClient. When a proxy is configured, AMQP_WEB_SOCKETS must be used for the transport type. The option is a: com.azure.core.amqp.ProxyOptions type. Group: common
      Parameters:
      proxyOptions - the value to set
      Returns:
      the dsl builder

    • proxyOptions

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder proxyOptions(String proxyOptions)
      Sets the proxy configuration to use for ServiceBusSenderClient. When a proxy is configured, AMQP_WEB_SOCKETS must be used for the transport type. The option will be converted to a com.azure.core.amqp.ProxyOptions type. Group: common
      Parameters:
      proxyOptions - the value to set
      Returns:
      the dsl builder

    • serviceBusType

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder serviceBusType(org.apache.camel.component.azure.servicebus.ServiceBusType serviceBusType)
      The service bus type of connection to execute. Queue is for typical queue option and topic for subscription based model. The option is a: org.apache.camel.component.azure.servicebus.ServiceBusType type. Required: true Default: queue Group: common
      Parameters:
      serviceBusType - the value to set
      Returns:
      the dsl builder

    • serviceBusType

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder serviceBusType(String serviceBusType)
      The service bus type of connection to execute. Queue is for typical queue option and topic for subscription based model. The option will be converted to a org.apache.camel.component.azure.servicebus.ServiceBusType type. Required: true Default: queue Group: common
      Parameters:
      serviceBusType - the value to set
      Returns:
      the dsl builder

    • enableDeadLettering

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder enableDeadLettering(boolean enableDeadLettering)
      Enable application level deadlettering to the subscription deadletter subqueue if deadletter related headers are set. The option is a: boolean type. Default: false Group: consumer
      Parameters:
      enableDeadLettering - the value to set
      Returns:
      the dsl builder

    • enableDeadLettering

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder enableDeadLettering(String enableDeadLettering)
      Enable application level deadlettering to the subscription deadletter subqueue if deadletter related headers are set. The option will be converted to a boolean type. Default: false Group: consumer
      Parameters:
      enableDeadLettering - the value to set
      Returns:
      the dsl builder

    • maxAutoLockRenewDuration

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder maxAutoLockRenewDuration(Duration maxAutoLockRenewDuration)
      Sets the amount of time to continue auto-renewing the lock. Setting ZERO disables auto-renewal. For ServiceBus receive mode (RECEIVE_AND_DELETE RECEIVE_AND_DELETE), auto-renewal is disabled. The option is a: java.time.Duration type. Default: 5m Group: consumer
      Parameters:
      maxAutoLockRenewDuration - the value to set
      Returns:
      the dsl builder

    • maxAutoLockRenewDuration

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder maxAutoLockRenewDuration(String maxAutoLockRenewDuration)
      Sets the amount of time to continue auto-renewing the lock. Setting ZERO disables auto-renewal. For ServiceBus receive mode (RECEIVE_AND_DELETE RECEIVE_AND_DELETE), auto-renewal is disabled. The option will be converted to a java.time.Duration type. Default: 5m Group: consumer
      Parameters:
      maxAutoLockRenewDuration - the value to set
      Returns:
      the dsl builder

    • maxConcurrentCalls

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder maxConcurrentCalls(int maxConcurrentCalls)
      Sets maximum number of concurrent calls. The option is a: int type. Default: 1 Group: consumer
      Parameters:
      maxConcurrentCalls - the value to set
      Returns:
      the dsl builder

    • maxConcurrentCalls

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder maxConcurrentCalls(String maxConcurrentCalls)
      Sets maximum number of concurrent calls. The option will be converted to a int type. Default: 1 Group: consumer
      Parameters:
      maxConcurrentCalls - the value to set
      Returns:
      the dsl builder

    • prefetchCount

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder prefetchCount(int prefetchCount)
      Sets the prefetch count of the receiver. For both PEEK_LOCK PEEK_LOCK and RECEIVE_AND_DELETE RECEIVE_AND_DELETE receive modes the default value is 1. Prefetch speeds up the message flow by aiming to have a message readily available for local retrieval when and before the application asks for one using receive message. Setting a non-zero value will prefetch that number of messages. Setting the value to zero turns prefetch off. The option is a: int type. Group: consumer
      Parameters:
      prefetchCount - the value to set
      Returns:
      the dsl builder

    • prefetchCount

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder prefetchCount(String prefetchCount)
      Sets the prefetch count of the receiver. For both PEEK_LOCK PEEK_LOCK and RECEIVE_AND_DELETE RECEIVE_AND_DELETE receive modes the default value is 1. Prefetch speeds up the message flow by aiming to have a message readily available for local retrieval when and before the application asks for one using receive message. Setting a non-zero value will prefetch that number of messages. Setting the value to zero turns prefetch off. The option will be converted to a int type. Group: consumer
      Parameters:
      prefetchCount - the value to set
      Returns:
      the dsl builder

    • processorClient

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder processorClient(com.azure.messaging.servicebus.ServiceBusProcessorClient processorClient)
      Sets the processorClient in order to consume messages by the consumer. The option is a: com.azure.messaging.servicebus.ServiceBusProcessorClient type. Group: consumer
      Parameters:
      processorClient - the value to set
      Returns:
      the dsl builder

    • processorClient

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder processorClient(String processorClient)
      Sets the processorClient in order to consume messages by the consumer. The option will be converted to a com.azure.messaging.servicebus.ServiceBusProcessorClient type. Group: consumer
      Parameters:
      processorClient - the value to set
      Returns:
      the dsl builder

    • serviceBusReceiveMode

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder serviceBusReceiveMode(com.azure.messaging.servicebus.models.ServiceBusReceiveMode serviceBusReceiveMode)
      Sets the receive mode for the receiver. The option is a: com.azure.messaging.servicebus.models.ServiceBusReceiveMode type. Default: PEEK_LOCK Group: consumer
      Parameters:
      serviceBusReceiveMode - the value to set
      Returns:
      the dsl builder

    • serviceBusReceiveMode

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder serviceBusReceiveMode(String serviceBusReceiveMode)
      Sets the receive mode for the receiver. The option will be converted to a com.azure.messaging.servicebus.models.ServiceBusReceiveMode type. Default: PEEK_LOCK Group: consumer
      Parameters:
      serviceBusReceiveMode - the value to set
      Returns:
      the dsl builder

    • sessionEnabled

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder sessionEnabled(boolean sessionEnabled)
      Enable session support. The option is a: boolean type. Default: false Group: consumer
      Parameters:
      sessionEnabled - the value to set
      Returns:
      the dsl builder

    • sessionEnabled

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder sessionEnabled(String sessionEnabled)
      Enable session support. The option will be converted to a boolean type. Default: false Group: consumer
      Parameters:
      sessionEnabled - the value to set
      Returns:
      the dsl builder

    • subQueue

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder subQueue(com.azure.messaging.servicebus.models.SubQueue subQueue)
      Sets the type of the SubQueue to connect to. The option is a: com.azure.messaging.servicebus.models.SubQueue type. Group: consumer
      Parameters:
      subQueue - the value to set
      Returns:
      the dsl builder

    • subQueue

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder subQueue(String subQueue)
      Sets the type of the SubQueue to connect to. The option will be converted to a com.azure.messaging.servicebus.models.SubQueue type. Group: consumer
      Parameters:
      subQueue - the value to set
      Returns:
      the dsl builder

    • subscriptionName

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder subscriptionName(String subscriptionName)
      Sets the name of the subscription in the topic to listen to. topicOrQueueName and serviceBusType=topic must also be set. This property is required if serviceBusType=topic and the consumer is in use. The option is a: java.lang.String type. Group: consumer
      Parameters:
      subscriptionName - the value to set
      Returns:
      the dsl builder

    • connectionString

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder connectionString(String connectionString)
      Sets the connection string for a Service Bus namespace or a specific Service Bus resource. The option is a: java.lang.String type. Group: security
      Parameters:
      connectionString - the value to set
      Returns:
      the dsl builder

    • credentialType

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder credentialType(org.apache.camel.component.azure.servicebus.CredentialType credentialType)
      Determines the credential strategy to adopt. The option is a: org.apache.camel.component.azure.servicebus.CredentialType type. Default: CONNECTION_STRING Group: security
      Parameters:
      credentialType - the value to set
      Returns:
      the dsl builder

    • credentialType

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder credentialType(String credentialType)
      Determines the credential strategy to adopt. The option will be converted to a org.apache.camel.component.azure.servicebus.CredentialType type. Default: CONNECTION_STRING Group: security
      Parameters:
      credentialType - the value to set
      Returns:
      the dsl builder

    • fullyQualifiedNamespace

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder fullyQualifiedNamespace(String fullyQualifiedNamespace)
      Fully Qualified Namespace of the service bus. The option is a: java.lang.String type. Group: security
      Parameters:
      fullyQualifiedNamespace - the value to set
      Returns:
      the dsl builder

    • tokenCredential

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder tokenCredential(com.azure.core.credential.TokenCredential tokenCredential)
      A TokenCredential for Azure AD authentication. The option is a: com.azure.core.credential.TokenCredential type. Group: security
      Parameters:
      tokenCredential - the value to set
      Returns:
      the dsl builder

    • tokenCredential

      default ServiceBusEndpointBuilderFactory.ServiceBusEndpointConsumerBuilder tokenCredential(String tokenCredential)
      A TokenCredential for Azure AD authentication. The option will be converted to a com.azure.core.credential.TokenCredential type. Group: security
      Parameters:
      tokenCredential - the value to set
      Returns:
      the dsl builder