Package com.azure.spring.cloud.stream.binder.servicebus.core.properties

Class ServiceBusConsumerProperties

java.lang.Object
com.azure.spring.cloud.core.implementation.properties.AzureSdkProperties
com.azure.spring.cloud.core.implementation.properties.AzureAmqpSdkProperties
com.azure.spring.messaging.servicebus.core.properties.CommonProperties
com.azure.spring.messaging.servicebus.core.properties.ConsumerProperties
com.azure.spring.messaging.servicebus.core.properties.ProcessorProperties
com.azure.spring.cloud.stream.binder.servicebus.core.properties.ServiceBusConsumerProperties
All Implemented Interfaces:
com.azure.spring.cloud.core.properties.AzureProperties, com.azure.spring.cloud.core.provider.authentication.TokenCredentialOptionsProvider, com.azure.spring.cloud.core.provider.AzureProfileOptionsProvider, com.azure.spring.cloud.core.provider.ClientOptionsProvider, com.azure.spring.cloud.core.provider.connectionstring.ConnectionStringProvider, com.azure.spring.cloud.core.provider.ProxyOptionsProvider, com.azure.spring.cloud.core.provider.RetryOptionsProvider, com.azure.spring.cloud.service.implementation.servicebus.properties.ServiceBusClientCommonProperties, com.azure.spring.cloud.service.implementation.servicebus.properties.ServiceBusProcessorClientProperties, com.azure.spring.cloud.service.implementation.servicebus.properties.ServiceBusReceiverClientProperties, ServiceBusEntityOptionsProvider
public class ServiceBusConsumerProperties extends com.azure.spring.messaging.servicebus.core.properties.ProcessorProperties implements ServiceBusEntityOptionsProvider
Service Bus consumer properties.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface com.azure.spring.cloud.core.provider.AzureProfileOptionsProvider

    com.azure.spring.cloud.core.provider.AzureProfileOptionsProvider.AzureEnvironmentOptions, com.azure.spring.cloud.core.provider.AzureProfileOptionsProvider.CloudType, com.azure.spring.cloud.core.provider.AzureProfileOptionsProvider.ProfileOptions

    Nested classes/interfaces inherited from interface com.azure.spring.cloud.core.provider.ClientOptionsProvider

    com.azure.spring.cloud.core.provider.ClientOptionsProvider.AmqpClientOptions, com.azure.spring.cloud.core.provider.ClientOptionsProvider.ClientOptions, com.azure.spring.cloud.core.provider.ClientOptionsProvider.HttpClientOptions

    Nested classes/interfaces inherited from interface com.azure.spring.cloud.core.provider.ProxyOptionsProvider

    com.azure.spring.cloud.core.provider.ProxyOptionsProvider.AmqpProxyOptions, com.azure.spring.cloud.core.provider.ProxyOptionsProvider.HttpProxyOptions, com.azure.spring.cloud.core.provider.ProxyOptionsProvider.ProxyOptions

    Nested classes/interfaces inherited from interface com.azure.spring.cloud.core.provider.RetryOptionsProvider

    com.azure.spring.cloud.core.provider.RetryOptionsProvider.AmqpRetryOptions, com.azure.spring.cloud.core.provider.RetryOptionsProvider.RetryMode, com.azure.spring.cloud.core.provider.RetryOptionsProvider.RetryOptions

    Nested classes/interfaces inherited from interface com.azure.spring.cloud.core.provider.authentication.TokenCredentialOptionsProvider

    com.azure.spring.cloud.core.provider.authentication.TokenCredentialOptionsProvider.TokenCredentialOptions

  • Constructor Summary

    Constructors
    Constructor
    Description
    ServiceBusConsumerProperties()
    Create an instance of ServiceBusConsumerProperties.

  • Method Summary

    Modifier and Type
    Method
    Description
    Duration
    getDefaultMessageTimeToLive()
    Gets the default message time to live value.
    Long
    getMaxSizeInMegabytes()
    Gets the maximum size of the queue/topic in megabytes, which is the size of memory allocated for the queue/topic.
    boolean
    isRequeueRejected()
    Controls if the failed messages are routed to the DLQ
    void
    setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
    Set the defaultMessageTimeToLive property: ISO 8601 default message timespan to live value.
    void
    setMaxSizeInMegabytes(Long maxSizeInMegabytes)
    Set the maxSizeInMegabytes property: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue.
    void
    setRequeueRejected(boolean requeueRejected)
    Set checkpoint mode.

    Methods inherited from class com.azure.spring.messaging.servicebus.core.properties.ProcessorProperties

    getMaxConcurrentCalls, getMaxConcurrentSessions, setMaxConcurrentCalls, setMaxConcurrentSessions

    Methods inherited from class com.azure.spring.messaging.servicebus.core.properties.ConsumerProperties

    getAutoComplete, getMaxAutoLockRenewDuration, getPrefetchCount, getReceiveMode, getSessionEnabled, getSubQueue, getSubscriptionName, setAutoComplete, setMaxAutoLockRenewDuration, setPrefetchCount, setReceiveMode, setSessionEnabled, setSubQueue, setSubscriptionName

    Methods inherited from class com.azure.spring.messaging.servicebus.core.properties.CommonProperties

    getConnectionString, getDomainName, getEntityName, getEntityType, getFullyQualifiedNamespace, getNamespace, setConnectionString, setDomainName, setEntityName, setEntityType, setNamespace

    Methods inherited from class com.azure.spring.cloud.core.implementation.properties.AzureAmqpSdkProperties

    getClient, getProxy, getRetry

    Methods inherited from class com.azure.spring.cloud.core.implementation.properties.AzureSdkProperties

    getCredential, getProfile

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.spring.cloud.core.provider.AzureProfileOptionsProvider

    getProfile

    Methods inherited from interface com.azure.spring.cloud.core.provider.ClientOptionsProvider

    getClient

    Methods inherited from interface com.azure.spring.cloud.core.provider.connectionstring.ConnectionStringProvider

    getConnectionString

    Methods inherited from interface com.azure.spring.cloud.core.provider.ProxyOptionsProvider

    getProxy

    Methods inherited from interface com.azure.spring.cloud.core.provider.RetryOptionsProvider

    getRetry

    Methods inherited from interface com.azure.spring.cloud.service.implementation.servicebus.properties.ServiceBusClientCommonProperties

    getDomainName, getEntityName, getEntityType, getFullyQualifiedNamespace, getNamespace

    Methods inherited from interface com.azure.spring.cloud.service.implementation.servicebus.properties.ServiceBusReceiverClientProperties

    getAutoComplete, getMaxAutoLockRenewDuration, getPrefetchCount, getReceiveMode, getSessionEnabled, getSubQueue, getSubscriptionName

    Methods inherited from interface com.azure.spring.cloud.core.provider.authentication.TokenCredentialOptionsProvider

    getCredential

  • Constructor Details

  • Method Details

    • isRequeueRejected

      public boolean isRequeueRejected()
      Controls if the failed messages are routed to the DLQ
      Returns:
      boolean, default : false

    • setRequeueRejected

      public void setRequeueRejected(boolean requeueRejected)
      Set checkpoint mode.
      Parameters:
      requeueRejected - the requeue Rejected

    • getMaxSizeInMegabytes

      public Long getMaxSizeInMegabytes()
      Description copied from interface: ServiceBusEntityOptionsProvider
      Gets the maximum size of the queue/topic in megabytes, which is the size of memory allocated for the queue/topic.
      Specified by:
      getMaxSizeInMegabytes in interface ServiceBusEntityOptionsProvider
      Returns:
      the maxSizeInMegabytes value.

    • setMaxSizeInMegabytes

      public void setMaxSizeInMegabytes(Long maxSizeInMegabytes)
      Set the maxSizeInMegabytes property: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue.
      Parameters:
      maxSizeInMegabytes - the maxSizeInMegabytes value to set.

    • getDefaultMessageTimeToLive

      public Duration getDefaultMessageTimeToLive()
      Description copied from interface: ServiceBusEntityOptionsProvider
      Gets the default message time to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.Messages older than their TimeToLive value will expire and no longer be retained in the message store. Subscribers will be unable to receive expired messages. A message can have a lower TimeToLive value than that specified here, but by default TimeToLive is set to MaxValue. Therefore, this property becomes the default time to live value applied to messages.
      Specified by:
      getDefaultMessageTimeToLive in interface ServiceBusEntityOptionsProvider
      Returns:
      the defaultMessageTimeToLive value.

    • setDefaultMessageTimeToLive

      public void setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)
      Set the defaultMessageTimeToLive property: ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.
      Parameters:
      defaultMessageTimeToLive - the defaultMessageTimeToLive value to set.