com.netflix.hystrix.contrib.javanica.annotation

Annotation Type HystrixCollapser

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Documented
public @interface HystrixCollapser

This annotation is used to collapse some commands into a single backend dependency call. This annotation should be used together with HystrixCommand annotation.

Example:

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	batchMethod Method name of batch command.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	collapserKey Specifies a collapser key.
HystrixProperty[]	collapserProperties Specifies collapser properties.
com.netflix.hystrix.HystrixCollapser.Scope	scope Defines what scope the collapsing should occur within.

Element Detail

batchMethod

public abstract java.lang.String batchMethod

Method name of batch command.

Method must have the following signature:

     java.util.List method(java.util.List)
 

NOTE: batch method can have only one argument.

Returns:

method name of batch command

collapserKey

public abstract java.lang.String collapserKey

Specifies a collapser key.

default => the name of annotated method.

Returns:

collapser key.

Default:

""

scope

public abstract com.netflix.hystrix.HystrixCollapser.Scope scope

Defines what scope the collapsing should occur within.

default => the HystrixCollapser.Scope.REQUEST.

Returns:

HystrixCollapser.Scope

Default:

com.netflix.hystrix.HystrixCollapser.Scope.REQUEST

collapserProperties

public abstract HystrixProperty[] collapserProperties

Specifies collapser properties.

Returns:

collapser properties

Default:

{}