io.siddhi.annotation

Annotation Type Example

@Retention(value=RUNTIME)
 @Target(value={})
public @interface Example

An Optional annotation for storing an examples for a Siddhi Extension.

 eg:-
       @Extension(
                      ...
                      examples = { @Example(syntax = "from fooStream#window.time(10 sec)
                      select symbol as name, volume insert into barStream;",
                      description = "This will processing events that arrived within the last 10 seconds.")
      public CustomExtension extends ExtensionSuperClass {
          ...
      }
 

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description
String	syntax

Element Detail

syntax

public abstract String syntax

Default:

""

description

public abstract String description

Default:

""