jenkins.triggers

Interface SCMTriggerItem

All Known Implementing Classes:

FreeStyleProject, Project

public interface SCMTriggerItem

The item type accepted by SCMTrigger.

Since:

1.568

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SCMTriggerItem.SCMTriggerItems Utilities.

Method Summary

Modifier and Type	Method and Description
Item	asItem() Should be this.
int	getNextBuildNumber()
int	getQuietPeriod()
Collection<? extends SCM>	getSCMs() Obtains all active SCMs.
SCMTrigger	getSCMTrigger()
PollingResult	poll(TaskListener listener) Checks if there is any update in SCM.
QueueTaskFuture<?>	scheduleBuild2(int quietPeriod, Action... actions)
default boolean	schedulePolling() Schedules a polling of this project.

Method Detail

asItem

Item asItem()

Should be this.

getNextBuildNumber

int getNextBuildNumber()

See Also:

Job.getNextBuildNumber()

getQuietPeriod

int getQuietPeriod()

See Also:

ParameterizedJobMixIn.ParameterizedJob.getQuietPeriod()

scheduleBuild2

@CheckForNull
QueueTaskFuture<?> scheduleBuild2(int quietPeriod,
                                                Action... actions)

See Also:

ParameterizedJobMixIn.ParameterizedJob.scheduleBuild2(int, hudson.model.Action...)

poll

@NonNull
PollingResult poll(@NonNull
                            TaskListener listener)

Checks if there is any update in SCM.

The implementation is responsible for ensuring mutual exclusion between polling and builds if necessary.

The implementation is responsible for checking the SCMDecisionHandler before proceeding with the actual polling.

getSCMTrigger

@CheckForNull
SCMTrigger getSCMTrigger()

getSCMs

@NonNull
Collection<? extends SCM> getSCMs()

Obtains all active SCMs. May be used for informational purposes, or to determine whether to initiate polling.

Returns:

a possibly empty collection

schedulePolling

default boolean schedulePolling()

Schedules a polling of this project.