Package com.azure.spring.messaging.servicebus.core.properties

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 Link icon

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

    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 Link icon

    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 Link icon

    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 Link icon

    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 Link icon

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

  • Constructor Summary Link icon

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

  • Method Summary Link icon

    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 com.azure.spring.messaging.servicebus.core.properties.CommonProperties Link icon

    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 Link icon

    getClient, getProxy, getRetry

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

    getCredential, getProfile

    Methods inherited from class java.lang.Object Link icon

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

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

    getProfile

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

    getClient

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

    getConnectionString

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

    getProxy

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

    getRetry

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

    getCustomEndpointAddress, getDomainName, getEntityName, getEntityType, getFullyQualifiedNamespace, getNamespace

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

    getCredential

  • Constructor Details Link icon

    • ConsumerProperties Link icon

      public ConsumerProperties()
      Create an instance of ConsumerProperties.

  • Method Details Link icon

    • getSessionEnabled Link icon

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

    • setSessionEnabled Link icon

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

    • getAutoComplete Link icon

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

    • setAutoComplete Link icon

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

    • getPrefetchCount Link icon

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

    • setPrefetchCount Link icon

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

    • getSubQueue Link icon

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

    • setSubQueue Link icon

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

    • getReceiveMode Link icon

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

    • setReceiveMode Link icon

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

    • getSubscriptionName Link icon

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

    • setSubscriptionName Link icon

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

    • getMaxAutoLockRenewDuration Link icon

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

    • setMaxAutoLockRenewDuration Link icon

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