Class ConsumerProperties

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
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.ServiceBusReceiverClientProperties
Direct Known Subclasses:
ProcessorProperties
public class ConsumerProperties extends CommonProperties implements com.azure.spring.cloud.service.implementation.servicebus.properties.ServiceBusReceiverClientProperties
A service bus consumer related 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
    ConsumerProperties()
    Create an instance of ConsumerProperties.

  • Method Summary

    Modifier and Type
    Method
    Description
    Boolean
    getAutoComplete()
     
    Duration
    getMaxAutoLockRenewDuration()
     
    Integer
    getPrefetchCount()
     
    com.azure.messaging.servicebus.models.ServiceBusReceiveMode
    getReceiveMode()
     
    Boolean
    getSessionEnabled()
     
    com.azure.messaging.servicebus.models.SubQueue
    getSubQueue()
     
    String
    getSubscriptionName()
     
    void
    setAutoComplete(Boolean autoComplete)
    Set whether to enable auto-complete.
    void
    setMaxAutoLockRenewDuration(Duration maxAutoLockRenewDuration)
    Set the mau auto lock renew duration.
    void
    setPrefetchCount(Integer prefetchCount)
    Set the prefetch count.
    void
    setReceiveMode(com.azure.messaging.servicebus.models.ServiceBusReceiveMode receiveMode)
    Set the receiving mode.
    void
    setSessionEnabled(Boolean sessionEnabled)
    Set whether to enable session for the consumer.
    void
    setSubQueue(com.azure.messaging.servicebus.models.SubQueue subQueue)
    Set the sub queue.
    void
    setSubscriptionName(String subscriptionName)
    Set the subscription name.

    Methods inherited from class CommonProperties

    getConnectionString, getCustomEndpointAddress, getDomainName, getEntityName, getEntityType, getFullyQualifiedNamespace, getNamespace, setConnectionString, setCustomEndpointAddress, 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 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

    getCustomEndpointAddress, getDomainName, getEntityName, getEntityType, getFullyQualifiedNamespace, getNamespace

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

    getCredential

  • Constructor Details

    • ConsumerProperties

      public ConsumerProperties()
      Create an instance of ConsumerProperties.

  • Method Details

    • getSessionEnabled

      public Boolean getSessionEnabled()
      Specified by:
      getSessionEnabled in interface com.azure.spring.cloud.service.implementation.servicebus.properties.ServiceBusReceiverClientProperties

    • setSessionEnabled

      public void setSessionEnabled(Boolean sessionEnabled)
      Set whether to enable session for the consumer.
      Parameters:
      sessionEnabled - whether session is enabled for consumer.

    • getAutoComplete

      public Boolean getAutoComplete()
      Specified by:
      getAutoComplete in interface com.azure.spring.cloud.service.implementation.servicebus.properties.ServiceBusReceiverClientProperties

    • setAutoComplete

      public void setAutoComplete(Boolean autoComplete)
      Set whether to enable auto-complete.
      Parameters:
      autoComplete - whether auto-complete is enabled.

    • getPrefetchCount

      public Integer getPrefetchCount()
      Specified by:
      getPrefetchCount in interface com.azure.spring.cloud.service.implementation.servicebus.properties.ServiceBusReceiverClientProperties

    • setPrefetchCount

      public void setPrefetchCount(Integer prefetchCount)
      Set the prefetch count.
      Parameters:
      prefetchCount - the prefetch count.

    • getSubQueue

      public com.azure.messaging.servicebus.models.SubQueue getSubQueue()
      Specified by:
      getSubQueue in interface com.azure.spring.cloud.service.implementation.servicebus.properties.ServiceBusReceiverClientProperties

    • setSubQueue

      public void setSubQueue(com.azure.messaging.servicebus.models.SubQueue subQueue)
      Set the sub queue.
      Parameters:
      subQueue - the sub queue.

    • getReceiveMode

      public com.azure.messaging.servicebus.models.ServiceBusReceiveMode getReceiveMode()
      Specified by:
      getReceiveMode in interface com.azure.spring.cloud.service.implementation.servicebus.properties.ServiceBusReceiverClientProperties

    • setReceiveMode

      public void setReceiveMode(com.azure.messaging.servicebus.models.ServiceBusReceiveMode receiveMode)
      Set the receiving mode.
      Parameters:
      receiveMode - the receiving mode.

    • getSubscriptionName

      public String getSubscriptionName()
      Specified by:
      getSubscriptionName in interface com.azure.spring.cloud.service.implementation.servicebus.properties.ServiceBusReceiverClientProperties

    • setSubscriptionName

      public void setSubscriptionName(String subscriptionName)
      Set the subscription name.
      Parameters:
      subscriptionName - the subscription name.

    • getMaxAutoLockRenewDuration

      public Duration getMaxAutoLockRenewDuration()
      Specified by:
      getMaxAutoLockRenewDuration in interface com.azure.spring.cloud.service.implementation.servicebus.properties.ServiceBusReceiverClientProperties

    • setMaxAutoLockRenewDuration

      public void setMaxAutoLockRenewDuration(Duration maxAutoLockRenewDuration)
      Set the mau auto lock renew duration.
      Parameters:
      maxAutoLockRenewDuration - the mau auto lock renew duration.