Annotation Type Description


  • @Target(TYPE)
    @Documented
    @Retention(RUNTIME)
    public @interface Description
    Used to supply a description of the job implementation by annotating SchedulableJob implementations, such as configuration notes, scheduling instructions, etc. This description is shown in the Obsidian job configuration screen.

    Note: this annotation can be set on any superclass of the job. The Description closest to the actual SchedulableJob implementation will be used.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String value  
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String[] urls
      If specified, these values will be output as hyperlinks in the user interface.
    • Element Detail

      • value

        java.lang.String value
      • urls

        java.lang.String[] urls
        If specified, these values will be output as hyperlinks in the user interface. Used as a convenience mechanism to link to more extensive documentation about the job class.
        Since:
        4.9.0
        Default:
        {}