Package io.jenkins.plugins.gitlabrefs

Class GitLabRepositoryRefsParameterDefinition

java.lang.Object
hudson.model.ParameterDefinition
hudson.model.SimpleParameterDefinition
io.jenkins.plugins.gitlabrefs.GitLabRepositoryRefsParameterDefinition
All Implemented Interfaces:
ExtensionPoint, Describable<ParameterDefinition>, Serializable
public class GitLabRepositoryRefsParameterDefinition extends SimpleParameterDefinition
Lists branches and/or tags from a GitLab repository. defaultVersion is preselected and forced into the dropdown if missing. regex / exclude filter refs. Build page loads refs lazily via AJAX.

Pipeline Syntax / Snippet Generator: mandatory name, repoUrl; optional refKind (TAGS|BRANCHES|ALL, default ALL) and other options via setters (omitted when left at defaults).

See Also:

  • Constructor Details

    • GitLabRepositoryRefsParameterDefinition

      @DataBoundConstructor public GitLabRepositoryRefsParameterDefinition(String name, String repoUrl)
      Pipeline Syntax / DataBound: only required fields. Optional options use DataBoundSetter so Snippet Generator omits defaults.

  • Method Details

    • setDescription

      @DataBoundSetter public void setDescription(String description)
      Overrides:
      setDescription in class ParameterDefinition

    • setCredentialsId

      @DataBoundSetter public void setCredentialsId(String credentialsId)

    • setRefKind

      @DataBoundSetter public void setRefKind(String refKind)

    • setRegex

      @DataBoundSetter public void setRegex(String regex)

    • setExclude

      @DataBoundSetter public void setExclude(String exclude)

    • setDefaultVersion

      @DataBoundSetter public void setDefaultVersion(String defaultVersion)

    • setPerPage

      @DataBoundSetter public void setPerPage(int perPage)

    • setMaxPages

      @DataBoundSetter public void setMaxPages(int maxPages)

    • setMaxRows

      @DataBoundSetter public void setMaxRows(int maxRows)

    • setSortMode

      @DataBoundSetter public void setSortMode(String sortMode)

    • setConnectTimeoutMs

      @DataBoundSetter public void setConnectTimeoutMs(int connectTimeoutMs)

    • setReadTimeoutMs

      @DataBoundSetter public void setReadTimeoutMs(int readTimeoutMs)

    • getRepoUrl

      public String getRepoUrl()

    • getCredentialsId

      public String getCredentialsId()

    • getRefKind

      public String getRefKind()

    • getRegex

      public String getRegex()

    • getExclude

      public String getExclude()

    • getDefaultVersion

      public String getDefaultVersion()

    • getResolvedDefault

      public String getResolvedDefault()
      Effective default for Build preselection.

    • getPerPage

      public int getPerPage()

    • getMaxPages

      public int getMaxPages()

    • getMaxRows

      public int getMaxRows()

    • getSortMode

      public String getSortMode()

    • getConnectTimeoutMs

      public int getConnectTimeoutMs()

    • getReadTimeoutMs

      public int getReadTimeoutMs()

    • getChoices

      @NonNull public List<String> getChoices(Item context)
      Loads ref choices for the given job context.

    • createValue

      public ParameterValue createValue(String value)
      Specified by:
      createValue in class SimpleParameterDefinition

    • createValue

      public ParameterValue createValue(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject jo)
      Overrides:
      createValue in class ParameterDefinition

    • getDefaultParameterValue

      public ParameterValue getDefaultParameterValue()
      Overrides:
      getDefaultParameterValue in class ParameterDefinition