io.temporal.workflow

Annotation Type SignalMethod

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface SignalMethod

Indicates that the method is a signal handler method. Signal method is executed when workflow receives signal. This annotation applies only to workflow interface methods.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	name Name of the signal type.

Element Detail

name

public abstract java.lang.String name

Name of the signal type. Default is method name.

Be careful about names that contain special characters. These names can be used as metric tags. And systems like prometheus ignore metrics which have tags with unsupported characters.

Default:

""