Package com.dtolabs.rundeck.plugins.descriptions

Annotation Type PluginProperty

  • @Retention(RUNTIME)
@Target(FIELD)
public @interface PluginProperty
    Declares a Plugin class' field as a configurable property

    • Element Detail

      • name

        java.lang.String name
        Returns:
        The property identifier name
        Default:
        ""

      • title

        java.lang.String title
        Returns:
        The property display name
        Default:
        ""

      • description

        java.lang.String description
        Returns:
        The property description
        Default:
        ""

      • defaultValue

        java.lang.String defaultValue
        Returns:
        The default value as a string
        Default:
        ""

      • required

        boolean required
        Returns:
        True if the property value is required
        Default:
        false

      • scope

        PropertyScope scope
        Returns:
        The scope for resolving the property value at runtime
        Default:
        com.dtolabs.rundeck.core.plugins.configuration.PropertyScope.Unspecified

      • validatorClassName

        java.lang.String validatorClassName
        Returns:
        class name of a validator to use
        Default:
        ""

      • validatorClass

        java.lang.Class<?> validatorClass
        Returns:
        class of a validator to use
        Default:
        java.lang.Object.class