Package hudson.model

Class ParametersDefinitionProperty

    • Constructor Detail

      • ParametersDefinitionProperty

        public ParametersDefinitionProperty​(@NonNull
                                            List<ParameterDefinition> parameterDefinitions)
      • ParametersDefinitionProperty

        public ParametersDefinitionProperty​(@NonNull
                                            ParameterDefinition... parameterDefinitions)
    • Method Detail

      • getBuildButtonText

        public final String getBuildButtonText()
      • getParameterDefinitionNames

        public List<String> getParameterDefinitionNames()
        Gets the names of all the parameter definitions.
      • getJobActions

        public Collection<Action> getJobActions​(Job<?,​?> job)
        Description copied from class: JobProperty
        Actions to be displayed in the job page.

        Returning actions from this method allows a job property to add them to the left navigation bar in the job page.

        Action can implement additional marker interface to integrate with the UI in different ways.

        getJobActions in class JobProperty<Job<?,​?>>
        job - Always the same as JobProperty.owner but passed in anyway for backward compatibility (I guess.) You really need not use this value at all.
        can be empty but never null.
        See Also:
        ProminentProjectAction, PermalinkProjectAction
      • buildWithParameters

        public void buildWithParameters​(org.kohsuke.stapler.StaplerRequest req,
                                        org.kohsuke.stapler.StaplerResponse rsp,
                                        TimeDuration delay)
                                 throws IOException,
      • getDisplayName

        public String getDisplayName()
        Description copied from interface: Action
        Gets the string to be displayed. The convention is to capitalize the first letter of each word, such as "Test Result".
        Specified by:
        getDisplayName in interface Action
        Specified by:
        getDisplayName in interface ModelObject
        Can be null in case the action is hidden.
      • getIconFileName

        public String getIconFileName()
        Description copied from interface: Action
        Gets the name of the icon.
        Specified by:
        getIconFileName in interface Action
        If the icon name is prefixed with "symbol-", a Jenkins Symbol will be used.

        If just a file name (like "abc.gif") is returned, it will be interpreted as a file name inside /images/24x24. This is useful for using one of the stock images.

        If an absolute file name that starts from '/' is returned (like "/plugin/foo/abc.gif"), then it will be interpreted as a path from the context root of Jenkins. This is useful to pick up image files from a plugin.

        Finally, return null to hide it from the task list. This is normally not very useful, but this can be used for actions that only contribute floatBox.jelly and no task list item. The other case where this is useful is to avoid showing links that require a privilege when the user is anonymous.

        See Also:
        Jenkins Symbols, Functions.isAnonymous(), Functions.getIconFilePath(Action)
      • getUrlName

        public String getUrlName()
        Description copied from interface: Action
        Gets the URL path name.

        For example, if this method returns "xyz", and if the parent object (that this action is associated with) is bound to /foo/bar/zot, then this action object will be exposed to /foo/bar/zot/xyz.

        This method should return a string that's unique among other Actions.

        The returned string can be an absolute URL, like "", which is useful for directly connecting to external systems.

        If the returned string starts with '/', like '/foo', then it's assumed to be relative to the context path of the Jenkins webapp.

        Specified by:
        getUrlName in interface Action
        null if this action object doesn't need to be bound to web (when you do that, be sure to also return null from Action.getIconFileName().
        See Also:
        Functions.getActionUrl(String, Action)