public static class SCMTrigger.BuildAction extends Object implements RunAction2
Run
to show the polling log
that triggered that build.Modifier and Type | Field and Description |
---|---|
AbstractBuild |
build
Deprecated.
|
Constructor and Description |
---|
BuildAction(AbstractBuild build)
Deprecated.
|
BuildAction(Run<?,?> run) |
Modifier and Type | Method and Description |
---|---|
void |
doPollingLog(org.kohsuke.stapler.StaplerRequest req,
org.kohsuke.stapler.StaplerResponse rsp)
Sends out the raw polling log output.
|
String |
getDisplayName()
Gets the string to be displayed.
|
String |
getIconFileName()
Gets the name of the icon.
|
File |
getPollingLogFile()
Polling log that triggered the build.
|
AnnotatedLargeText |
getPollingLogText() |
Run<?,?> |
getRun() |
String |
getUrlName()
Gets the URL path name.
|
void |
onAttached(Run<?,?> r)
Called when this action is added to a build.
|
void |
onLoad(Run<?,?> r)
Called after a build is loaded to which this action was previously attached.
|
void |
writePollingLogTo(long offset,
org.apache.commons.jelly.XMLOutput out)
Used from
polling.jelly to write annotated polling log to the given output. |
@Deprecated public transient AbstractBuild build
public BuildAction(Run<?,?> run)
@Deprecated public BuildAction(AbstractBuild build)
public Run<?,?> getRun()
public File getPollingLogFile()
public String getIconFileName()
Action
getIconFileName
in interface Action
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.
Functions.isAnonymous()
,
Functions.getIconFilePath(Action)
public String getDisplayName()
Action
getDisplayName
in interface Action
getDisplayName
in interface ModelObject
public String getUrlName()
Action
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 Action
s.
The returned string can be an absolute URL, like "http://www.sun.com/", 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.
getUrlName
in interface Action
Action.getIconFileName()
.Functions.getActionUrl(String, Action)
public void doPollingLog(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) throws IOException
IOException
public AnnotatedLargeText getPollingLogText()
public void writePollingLogTo(long offset, org.apache.commons.jelly.XMLOutput out) throws IOException
polling.jelly
to write annotated polling log to the given output.IOException
public void onAttached(Run<?,?> r)
RunAction2
onAttached
in interface RunAction2
public void onLoad(Run<?,?> r)
RunAction2
onLoad
in interface RunAction2
Copyright © 2004–2022. All rights reserved.