Package org.jenkinsci.plugins.workflow.multibranch

Class PipelineTriggerProperty

  • All Implemented Interfaces:
    ExtensionPoint, Describable<com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<?>>, ReconfigurableDescribable<com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<?>>
    public class PipelineTriggerProperty
extends com.cloudbees.hudson.plugins.folder.AbstractFolderProperty<jenkins.branch.MultiBranchProject<?,​?>>
    Job property to enable setting jobs to trigger when a pipeline is created or deleted. In details by this, multi branch pipeline will trigger other job/jobs depending on the configuration. Jobs defined in Pipeline Pre Create Jobs Trigger Field, will be triggered when a new pipeline created by branch indexing. Jobs defined in Pipeline Post Create Jobs Trigger Field, will be triggered when a pipeline is deleted by branch indexing. Jobs defined in the Pipeline Run Delete Jobs Trigger Field will be triggered when a Pipeline run is deleted (either by explicitly deleting the run or the branch in the run.

    • Constructor Detail

      • PipelineTriggerProperty

        @DataBoundConstructor
public PipelineTriggerProperty​(String createActionJobsToTrigger,
                               String deleteActionJobsToTrigger,
                               String actionJobsToTriggerOnRunDelete,
                               String branchIncludeFilter,
                               String branchExcludeFilter,
                               List<AdditionalParameter> additionalParameters)
        Parameters:
        createActionJobsToTrigger - Full names of the jobs in comma separated format which are defined in the field
        deleteActionJobsToTrigger - Full names of the jobs in comma separated format which are defined in the field
        actionJobsToTriggerOnRunDelete - Full names of the jobs in comma separated format which are defined in the field
        See Also:
        DataBoundConstructor

    • Method Detail

      • getCreateActionJobsToTrigger

        public String getCreateActionJobsToTrigger()
        Getter method for @createActionJobsToTrigger
        Returns:
        Full names of the jobs in comma separated format

      • setCreateActionJobsToTrigger

        @DataBoundSetter
public void setCreateActionJobsToTrigger​(String createActionJobsToTrigger)
        Setter method for @createActionJobsToTrigger Additionally. this methods parses job names from @createActionJobsToTrigger, convert to List of Job and store in @createActionJobs for later use.
        Parameters:
        createActionJobsToTrigger - Full names of the jobs in comma separated format which are defined in the field

      • getDeleteActionJobsToTrigger

        public String getDeleteActionJobsToTrigger()
        Getter method for @deleteActionJobsToTrigger
        Returns:
        Full names of the jobs in comma-separated format

      • setDeleteActionJobsToTrigger

        @DataBoundSetter
public void setDeleteActionJobsToTrigger​(String deleteActionJobsToTrigger)
        Setter method for @deleteActionJobsToTrigger Additionally. this methods parses job names from @deleteActionJobsToTrigger, convert to List of Job and store in @deleteActionJobs for later use.
        Parameters:
        deleteActionJobsToTrigger - Full names of the jobs in comma-separated format which are defined in the field

      • getActionJobsToTriggerOnRunDelete

        public String getActionJobsToTriggerOnRunDelete()
        Getter method for @actionJobsToTriggerOnRunDelete
        Returns:
        Full names of the jobs in comma-separated format

      • setActionJobsToTriggerOnRunDelete

        @DataBoundSetter
public void setActionJobsToTriggerOnRunDelete​(String actionJobsToTriggerOnRunDelete)
        Setter method for @actionJobsToTriggerOnRunDelete Additionally. this methods parses job names from @actionJobsToTriggerOnRunDelete, convert to List of Job and store in @actionJobsOnRunDelete for later use.
        Parameters:
        actionJobsToTriggerOnRunDelete - Full names of the jobs in comma-separated format which are defined in the field

      • getCreateActionJobs

        public List<Job> getCreateActionJobs()
        Getter method for @createActionJobs
        Returns:
        List of Job for Pre Action

      • setCreateActionJobs

        public void setCreateActionJobs​(List<Job> createActionJobs)
        Setter method for @createActionJobs
        Parameters:
        createActionJobs - List of Job for Pre Action

      • getDeleteActionJobs

        public List<Job> getDeleteActionJobs()
        Getter method for @deleteActionJobs
        Returns:
        List of Job for Post Action

      • setDeleteActionJobs

        public void setDeleteActionJobs​(List<Job> deleteActionJobs)
        Setter method for @createActionJobs
        Parameters:
        deleteActionJobs - List of Job for Post Action

      • getActionJobsOnRunDelete

        public List<Job> getActionJobsOnRunDelete()
        Getter method for @actionJobsOnRunDelete
        Returns:
        List of Job for Run Delete Action

      • setActionJobsOnRunDelete

        public void setActionJobsOnRunDelete​(List<Job> actionJobsOnRunDelete)
        Setter method for @actionJobsOnRunDelete
        Parameters:
        actionJobsOnRunDelete - List of Job for Run Delete Action

      • setTriggerJobParameters

        public void setTriggerJobParameters()

      • triggerDeleteActionJobs

        public void triggerDeleteActionJobs​(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob)

      • triggerCreateActionJobs

        public void triggerCreateActionJobs​(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob)

      • triggerActionJobsOnRunDelete

        public void triggerActionJobsOnRunDelete​(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob,
                                         Run<?,​?> run)

      • getBranchIncludeFilter

        public String getBranchIncludeFilter()

      • setBranchIncludeFilter

        @DataBoundSetter
public void setBranchIncludeFilter​(String branchIncludeFilter)

      • getBranchExcludeFilter

        public String getBranchExcludeFilter()

      • setBranchExcludeFilter

        @DataBoundSetter
public void setBranchExcludeFilter​(String branchExcludeFilter)

      • convertToPattern

        public static String convertToPattern​(String wildcardDefinitions)

      • setAdditionalParameters

        @DataBoundSetter
public void setAdditionalParameters​(List<AdditionalParameter> additionalParameters)

      • triggerPipelineTriggerPropertyFromParentForOnCreate

        public static void triggerPipelineTriggerPropertyFromParentForOnCreate​(Item item)

      • triggerPipelineTriggerPropertyFromParentForOnDelete

        public static void triggerPipelineTriggerPropertyFromParentForOnDelete​(Item item)

      • triggerPipelineTriggerPropertyFromParentForOnRunDelete

        public static void triggerPipelineTriggerPropertyFromParentForOnRunDelete​(Run run)

      • getPullRequestInfo

        public PullRequestInfo getPullRequestInfo​(org.jenkinsci.plugins.workflow.job.WorkflowJob workflowJob)
        Get Pull Request related information from workflow job.
        Parameters:
        workflowJob - Indexed job
        Returns:
        PullRequestInfo