io.micronaut.configuration.hystrix.annotation

Annotation Type HystrixCommand

@Documented
 @Retention(value=RUNTIME)
 @Target(value={METHOD,TYPE,ANNOTATION_TYPE})
 @Around
 @Type(value=HystrixInterceptor.class)
public @interface HystrixCommand

Applies AOP advise applied to Hystrix.

Since:

1.0

Author:

graemerocher

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	command Same as value().
java.lang.String	group The command group key is used for grouping together commands such as for reporting, alerting, dashboards or team/library ownership.
io.micronaut.context.annotation.Property[]	properties
java.lang.String	threadPool The thread-pool key is used to represent a HystrixThreadPool for monitoring, metrics publishing, caching and other such uses.
java.lang.String	value Hystrix command key.

Element Detail

value

public abstract java.lang.String value

Hystrix command key.

default => the name of annotated method. for example:

... @HystrixCommand public User getUserById(...) ...

the command name will be: 'getUserById'

Returns:

command key

Default:

""

command

@AliasFor(member="value")
public abstract java.lang.String command

Same as value().

Returns:

command value

See Also:

value()

Default:

""

group

@AliasFor(annotation=Hystrix.class,
          member="group")
public abstract java.lang.String group

The command group key is used for grouping together commands such as for reporting, alerting, dashboards or team/library ownership.

default => The @Client ID if found otherwise the runtime class name of annotated method

Returns:

group key

Default:

""

threadPool

@AliasFor(annotation=Hystrix.class,
          member="threadPool")
public abstract java.lang.String threadPool

The thread-pool key is used to represent a HystrixThreadPool for monitoring, metrics publishing, caching and other such uses.

Returns:

thread pool key

Default:

""

properties

@AliasFor(annotation=Hystrix.class,
          member="commandProperties")
public abstract io.micronaut.context.annotation.Property[] properties

Returns:

Additional command specific Hystrix properties

See Also:

HystrixCommandProperties

Default:

{}