Class ConsumerProperties
- java.lang.Object
-
- org.springframework.cloud.stream.binder.ConsumerProperties
-
- Direct Known Subclasses:
ExtendedConsumerProperties
public class ConsumerProperties extends Object
Common consumer properties - spring.cloud.stream.bindings.[destinationName].consumer.- Author:
- Marius Bogoevici, Ilayaperumal Gopinathan, Gary Russell, Soby Chacko, Oleg Zhurakousky, Nicolas Homble, Michael Michailidis
-
-
Constructor Summary
Constructors Constructor Description ConsumerProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description @javax.validation.constraints.Min(value=1L, message="Backoff initial interval should be greater than zero.") intgetBackOffInitialInterval()@javax.validation.constraints.Min(value=1L, message="Backoff max interval should be greater than zero.") intgetBackOffMaxInterval()@javax.validation.constraints.Min(value=1L, message="Backoff multiplier should be greater than zero.") doublegetBackOffMultiplier()StringgetBindingName()@javax.validation.constraints.Min(value=1L, message="Concurrency should be greater than zero.") intgetConcurrency()HeaderModegetHeaderMode()@javax.validation.constraints.Min(value=-1L, message="Instance count should be greater than or equal to -1.") intgetInstanceCount()@javax.validation.constraints.Min(value=-1L, message="Instance index should be greater than or equal to -1") intgetInstanceIndex()List<Integer>getInstanceIndexList()@javax.validation.constraints.Min(value=1L, message="Max attempts should be greater than zero.") intgetMaxAttempts()Map<Class<? extends Throwable>,Boolean>getRetryableExceptions()StringgetRetryTemplateName()booleanisAutoStartup()booleanisBatchMode()booleanisDefaultRetryable()booleanisMultiplex()booleanisPartitioned()booleanisUseNativeDecoding()voidpopulateBindingName(String bindingName)This method is not intended as a configuration property to set by the applications.voidsetAutoStartup(boolean autoStartup)voidsetBackOffInitialInterval(int backOffInitialInterval)voidsetBackOffMaxInterval(int backOffMaxInterval)voidsetBackOffMultiplier(double backOffMultiplier)voidsetBatchMode(boolean batchMode)voidsetConcurrency(int concurrency)voidsetDefaultRetryable(boolean defaultRetryable)voidsetHeaderMode(HeaderMode headerMode)voidsetInstanceCount(int instanceCount)voidsetInstanceIndex(int instanceIndex)voidsetInstanceIndexList(List<Integer> instanceIndexList)voidsetMaxAttempts(int maxAttempts)voidsetMultiplex(boolean multiplex)voidsetPartitioned(boolean partitioned)voidsetRetryableExceptions(Map<Class<? extends Throwable>,Boolean> retryableExceptions)voidsetRetryTemplateName(String retryTemplateName)voidsetUseNativeDecoding(boolean useNativeDecoding)
-
-
-
Method Detail
-
getBindingName
public String getBindingName()
-
populateBindingName
public void populateBindingName(String bindingName)
This method is not intended as a configuration property to set by the applications. Therefore, we are not providing a proper setter method for this.- Parameters:
bindingName- binding name populated by the framework.
-
getRetryTemplateName
public String getRetryTemplateName()
-
setRetryTemplateName
public void setRetryTemplateName(String retryTemplateName)
-
getConcurrency
@Min(value=1L, message="Concurrency should be greater than zero.") public @javax.validation.constraints.Min(value=1L, message="Concurrency should be greater than zero.") int getConcurrency()
-
setConcurrency
public void setConcurrency(int concurrency)
-
isPartitioned
public boolean isPartitioned()
-
setPartitioned
public void setPartitioned(boolean partitioned)
-
getInstanceCount
@Min(value=-1L, message="Instance count should be greater than or equal to -1.") public @javax.validation.constraints.Min(value=-1L, message="Instance count should be greater than or equal to -1.") int getInstanceCount()
-
setInstanceCount
public void setInstanceCount(int instanceCount)
-
getInstanceIndex
@Min(value=-1L, message="Instance index should be greater than or equal to -1") public @javax.validation.constraints.Min(value=-1L, message="Instance index should be greater than or equal to -1") int getInstanceIndex()
-
setInstanceIndex
public void setInstanceIndex(int instanceIndex)
-
getMaxAttempts
@Min(value=1L, message="Max attempts should be greater than zero.") public @javax.validation.constraints.Min(value=1L, message="Max attempts should be greater than zero.") int getMaxAttempts()
-
setMaxAttempts
public void setMaxAttempts(int maxAttempts)
-
getBackOffInitialInterval
@Min(value=1L, message="Backoff initial interval should be greater than zero.") public @javax.validation.constraints.Min(value=1L, message="Backoff initial interval should be greater than zero.") int getBackOffInitialInterval()
-
setBackOffInitialInterval
public void setBackOffInitialInterval(int backOffInitialInterval)
-
getBackOffMaxInterval
@Min(value=1L, message="Backoff max interval should be greater than zero.") public @javax.validation.constraints.Min(value=1L, message="Backoff max interval should be greater than zero.") int getBackOffMaxInterval()
-
setBackOffMaxInterval
public void setBackOffMaxInterval(int backOffMaxInterval)
-
getBackOffMultiplier
@Min(value=1L, message="Backoff multiplier should be greater than zero.") public @javax.validation.constraints.Min(value=1L, message="Backoff multiplier should be greater than zero.") double getBackOffMultiplier()
-
setBackOffMultiplier
public void setBackOffMultiplier(double backOffMultiplier)
-
isDefaultRetryable
public boolean isDefaultRetryable()
-
setDefaultRetryable
public void setDefaultRetryable(boolean defaultRetryable)
-
setRetryableExceptions
public void setRetryableExceptions(Map<Class<? extends Throwable>,Boolean> retryableExceptions)
-
getHeaderMode
public HeaderMode getHeaderMode()
-
setHeaderMode
public void setHeaderMode(HeaderMode headerMode)
-
isUseNativeDecoding
public boolean isUseNativeDecoding()
-
setUseNativeDecoding
public void setUseNativeDecoding(boolean useNativeDecoding)
-
isMultiplex
public boolean isMultiplex()
-
setMultiplex
public void setMultiplex(boolean multiplex)
-
isAutoStartup
public boolean isAutoStartup()
-
setAutoStartup
public void setAutoStartup(boolean autoStartup)
-
isBatchMode
public boolean isBatchMode()
-
setBatchMode
public void setBatchMode(boolean batchMode)
-
-