HystrixCollapserProperties (Hystrix Javadoc 1.5.3)

java.lang.Object
- com.netflix.hystrix.HystrixCollapserProperties

Direct Known Subclasses:

HystrixPropertiesCollapserDefault
```
public abstract class HystrixCollapserProperties
extends java.lang.Object
```
Properties for instances of HystrixCollapser.
Default implementation of methods uses Archaius (https://github.com/Netflix/archaius)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HystrixCollapserProperties.Setter` Fluent interface that allows chained setting of properties that can be passed into a `HystrixCollapser` constructor to inject instance specific property overrides.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`HystrixCollapserProperties(HystrixCollapserKey collapserKey)`
`protected`	`HystrixCollapserProperties(HystrixCollapserKey collapserKey, HystrixCollapserProperties.Setter builder)`
`protected`	`HystrixCollapserProperties(HystrixCollapserKey key, HystrixCollapserProperties.Setter builder, java.lang.String propertyPrefix)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static HystrixCollapserProperties.Setter`	`defaultSetter()` Factory method to retrieve the default Setter.
`HystrixProperty<java.lang.Integer>`	`maxRequestsInBatch()` The maximum number of requests allowed in a batch before triggering a batch execution.
`HystrixProperty<java.lang.Integer>`	`metricsRollingPercentileBucketSize()` Maximum number of values stored in each bucket of the rolling percentile.
`HystrixProperty<java.lang.Boolean>`	`metricsRollingPercentileEnabled()` Whether percentile metrics should be captured using `HystrixRollingPercentile` inside `HystrixCollapserMetrics`.
`HystrixProperty<java.lang.Integer>`	`metricsRollingPercentileWindowBuckets()` Number of buckets the rolling percentile window is broken into.
`HystrixProperty<java.lang.Integer>`	`metricsRollingPercentileWindowInMilliseconds()` Duration of percentile rolling window in milliseconds.
`HystrixProperty<java.lang.Integer>`	`metricsRollingStatisticalWindowBuckets()` Number of buckets the rolling statistical window is broken into.
`HystrixProperty<java.lang.Integer>`	`metricsRollingStatisticalWindowInMilliseconds()` Duration of statistical rolling window in milliseconds.
`HystrixProperty<java.lang.Boolean>`	`requestCacheEnabled()` Whether request caching is enabled for `HystrixCollapser.execute()` and `HystrixCollapser.queue()` invocations.
`HystrixProperty<java.lang.Boolean>`	`requestCachingEnabled()` Deprecated.
`static HystrixCollapserProperties.Setter`	`Setter()` Factory method to retrieve the default Setter.
`HystrixProperty<java.lang.Integer>`	`timerDelayInMilliseconds()` The number of milliseconds between batch executions (unless `maxRequestsInBatch` is hit which will cause a batch to execute early.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HystrixCollapserProperties
```
protected HystrixCollapserProperties(HystrixCollapserKey collapserKey)
```
  - HystrixCollapserProperties
```
protected HystrixCollapserProperties(HystrixCollapserKey collapserKey,
                                     HystrixCollapserProperties.Setter builder)
```
  - HystrixCollapserProperties
```
protected HystrixCollapserProperties(HystrixCollapserKey key,
                                     HystrixCollapserProperties.Setter builder,
                                     java.lang.String propertyPrefix)
```
- Method Detail
  - requestCachingEnabled
```
@Deprecated
public HystrixProperty<java.lang.Boolean> requestCachingEnabled()
```
    Deprecated.
    
    Whether request caching is enabled for HystrixCollapser.execute() and HystrixCollapser.queue() invocations. Deprecated as of 1.4.0-RC7 in favor of requestCacheEnabled() (to match HystrixCommandProperties.requestCacheEnabled()
    
    Returns:
    
    HystrixProperty<Boolean>
  - requestCacheEnabled
```
public HystrixProperty<java.lang.Boolean> requestCacheEnabled()
```
    Whether request caching is enabled for HystrixCollapser.execute() and HystrixCollapser.queue() invocations.
    
    Returns:
    
    HystrixProperty<Boolean>
  - maxRequestsInBatch
```
public HystrixProperty<java.lang.Integer> maxRequestsInBatch()
```
    The maximum number of requests allowed in a batch before triggering a batch execution.
    
    Returns:
    
    HystrixProperty<Integer>
  - timerDelayInMilliseconds
```
public HystrixProperty<java.lang.Integer> timerDelayInMilliseconds()
```
    The number of milliseconds between batch executions (unless maxRequestsInBatch is hit which will cause a batch to execute early.
    
    Returns:
    
    HystrixProperty<Integer>
  - metricsRollingStatisticalWindowInMilliseconds
```
public HystrixProperty<java.lang.Integer> metricsRollingStatisticalWindowInMilliseconds()
```
    Duration of statistical rolling window in milliseconds. This is passed into HystrixRollingNumber inside HystrixCommandMetrics.
    
    Returns:
    
    HystrixProperty<Integer>
  - metricsRollingStatisticalWindowBuckets
```
public HystrixProperty<java.lang.Integer> metricsRollingStatisticalWindowBuckets()
```
    Number of buckets the rolling statistical window is broken into. This is passed into HystrixRollingNumber inside HystrixCollapserMetrics.
    
    Returns:
    
    HystrixProperty<Integer>
  - metricsRollingPercentileEnabled
```
public HystrixProperty<java.lang.Boolean> metricsRollingPercentileEnabled()
```
    Whether percentile metrics should be captured using HystrixRollingPercentile inside HystrixCollapserMetrics.
    
    Returns:
    
    HystrixProperty<Boolean>
  - metricsRollingPercentileWindowInMilliseconds
```
public HystrixProperty<java.lang.Integer> metricsRollingPercentileWindowInMilliseconds()
```
    Duration of percentile rolling window in milliseconds. This is passed into HystrixRollingPercentile inside HystrixCollapserMetrics.
    
    Returns:
    
    HystrixProperty<Integer>
  - metricsRollingPercentileWindowBuckets
```
public HystrixProperty<java.lang.Integer> metricsRollingPercentileWindowBuckets()
```
    Number of buckets the rolling percentile window is broken into. This is passed into HystrixRollingPercentile inside HystrixCollapserMetrics.
    
    Returns:
    
    HystrixProperty<Integer>
  - metricsRollingPercentileBucketSize
```
public HystrixProperty<java.lang.Integer> metricsRollingPercentileBucketSize()
```
    Maximum number of values stored in each bucket of the rolling percentile. This is passed into HystrixRollingPercentile inside HystrixCollapserMetrics.
    
    Returns:
    
    HystrixProperty<Integer>
  - Setter
```
public static HystrixCollapserProperties.Setter Setter()
```
    Factory method to retrieve the default Setter.
  - defaultSetter
```
public static HystrixCollapserProperties.Setter defaultSetter()
```
    Factory method to retrieve the default Setter. Groovy has a bug (GROOVY-6286) which does not allow method names and inner classes to have the same name This method fixes Issue #967 and allows Groovy consumers to choose this method and not trigger the bug

Hystrix: Latency and Fault Tolerance for Distributed Systems

Class HystrixCollapserProperties

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HystrixCollapserProperties

HystrixCollapserProperties

HystrixCollapserProperties

Method Detail

requestCachingEnabled

requestCacheEnabled

maxRequestsInBatch

timerDelayInMilliseconds

metricsRollingStatisticalWindowInMilliseconds

metricsRollingStatisticalWindowBuckets

metricsRollingPercentileEnabled

metricsRollingPercentileWindowInMilliseconds

metricsRollingPercentileWindowBuckets

metricsRollingPercentileBucketSize

Setter

defaultSetter