Package com.dtolabs.rundeck.core.plugins.configuration

Interface Property

  • public interface Property
    Property describes a configuration property of a provider

    • Method Detail

      • getTitle

        java.lang.String getTitle()
        Returns:
        descriptive name of the property

      • getName

        java.lang.String getName()
        Returns:
        property key to use

      • getDescription

        java.lang.String getDescription()
        Returns:
        description of the values of the property

      • getValidator

        PropertyValidator getValidator()
        Returns:
        the validator for this property

      • isRequired

        boolean isRequired()
        Returns:
        true if an empty value is not allowed

      • getDefaultValue

        java.lang.String getDefaultValue()
        Returns:
        the default value of the property, or default select value to select

      • getSelectValues

        java.util.List<java.lang.String> getSelectValues()
        Returns:
        a list of values for a select property

      • getSelectLabels

        java.util.Map<java.lang.String,​java.lang.String> getSelectLabels()
        Returns:
        a map of display labels to use for the select values, keyed by value

      • getScope

        PropertyScope getScope()
        Returns:
        the scope of this property, i.e. where the value can be retrieved and overridden, or null to indicate the default scope.

      • getRenderingOptions

        java.util.Map<java.lang.String,​java.lang.Object> getRenderingOptions()
        Returns:
        a map of optional rendering options for the UI

      • isBlankIfUnexpandable

        default boolean isBlankIfUnexpandable()
        Returns:
        if true, variable that cannot be expanded will be replaced by a blank string otherwise unexpanded variables will be left as is