|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD | DETAIL: FIELD | PROPERTY | CONSTR | METHOD |
java.lang.Objectjavaposse.jobdsl.dsl.helpers.AbstractHelper
javaposse.jobdsl.dsl.helpers.TopLevelHelper
class TopLevelHelper extends AbstractHelper
Nested Class Summary | |
---|---|
static class |
TopLevelHelper.EnvironmentVariableContext
|
static class |
TopLevelHelper.Port
|
static class |
TopLevelHelper.PortsContext
|
static enum |
TopLevelHelper.Timeout
Enumeration of timeout types for parsing and error reporting |
static class |
TopLevelHelper.TimeoutContext
Context to configure timeout |
Property Summary | |
---|---|
JobManagement |
jobManagement
|
boolean |
labelAlreadyAdded
"Restrict where this project can be run"
|
Constructor Summary | |
TopLevelHelper(java.util.List withXmlActions, JobType jobType, JobManagement jobManagement)
|
Method Summary | |
---|---|
java.lang.Object
|
allocatePorts(java.lang.String[] portsArg, groovy.lang.Closure closure = null)
|
java.lang.Object
|
allocatePorts(groovy.lang.Closure cl = null)
|
java.lang.Object
|
blockOn(java.lang.Iterable projectNames)
Block build if certain jobs are running
|
java.lang.Object
|
blockOn(java.lang.String projectName)
Block build if certain jobs are running. |
java.lang.Object
|
blockOnDownstreamProjects()
Configures the job to block when downstream projects are building. |
java.lang.Object
|
blockOnUpstreamProjects()
Configures the job to block when upstream projects are building. |
java.lang.Object
|
checkoutRetryCount(int times = 3)
Sets the number of times the SCM checkout is retried on errors. |
java.lang.Object
|
customWorkspace(java.lang.String workspacePath)
Configures a custom workspace for the project. |
java.lang.Object
|
description(java.lang.String descriptionString)
|
java.lang.Object
|
disabled(boolean shouldDisable = true)
|
java.lang.Object
|
displayName(java.lang.String displayName)
Sets a display name for the project. |
java.lang.Object
|
environmentVariables(groovy.lang.Closure envClosure)
Add environment variables to the build. |
java.lang.Object
|
environmentVariables(java.util.Map vars, groovy.lang.Closure envClosure = null)
|
java.lang.Object
|
jdk(java.lang.String jdkArg)
Name of the JDK installation to use for this job. |
java.lang.Object
|
keepDependencies(boolean keep = true)
Configures the keep Dependencies Flag which can be set in the Fingerprinting action |
java.lang.Object
|
label(java.lang.String labelExpression = null)
|
java.lang.Object
|
logRotator(int daysToKeepInt = -1, int numToKeepInt = -1, int artifactDaysToKeepInt = -1, int artifactNumToKeepInt = -1)
|
java.lang.Object
|
priority(int value)
Priority of this job. |
java.lang.Object
|
quietPeriod(int seconds = 5)
Adds a quiet period to the project. |
java.lang.Object
|
runOnSameNodeAs(java.lang.String jobName, boolean useSameWorkspace = false)
|
java.lang.Object
|
rvm(java.lang.String rubySpecification)
Support for builds using a rvm environment. |
java.lang.Object
|
sshAgent(java.lang.String credentials)
|
java.lang.Object
|
timeout(java.lang.Integer timeoutInMinutes, java.lang.Boolean shouldFailBuild = true)
|
java.lang.Object
|
timeout(java.lang.String type = absolute.toString(, groovy.lang.Closure timeoutClosure = null)
Add a timeout to the build job. |
Methods inherited from class AbstractHelper | |
---|---|
execute |
Property Detail |
---|
JobManagement jobManagement
boolean labelAlreadyAdded
labelExpression
- Label of node to use, if null is passed in, the label is cleared out and it can roam
Constructor Detail |
---|
TopLevelHelper(java.util.List withXmlActions, JobType jobType, JobManagement jobManagement)
Method Detail |
---|
java.lang.Object allocatePorts(java.lang.String[] portsArg, groovy.lang.Closure closure = null)
java.lang.Object allocatePorts(groovy.lang.Closure cl = null)
java.lang.Object blockOn(java.lang.Iterable projectNames)
java.lang.Object blockOn(java.lang.String projectName)
projectName
- Can be regular expressions. Newline delimited.
java.lang.Object blockOnDownstreamProjects()
java.lang.Object blockOnUpstreamProjects()
java.lang.Object checkoutRetryCount(int times = 3)
times
- number of attempts
java.lang.Object customWorkspace(java.lang.String workspacePath)
workspacePath
- workspace path to use
java.lang.Object description(java.lang.String descriptionString)
java.lang.Object disabled(boolean shouldDisable = true)
java.lang.Object displayName(java.lang.String displayName)
displayName
- name to display
java.lang.Object environmentVariables(groovy.lang.Closure envClosure)
java.lang.Object environmentVariables(java.util.Map vars, groovy.lang.Closure envClosure = null)
java.lang.Object jdk(java.lang.String jdkArg)
jdkArg
- name of the JDK installation to use for this job.
java.lang.Object keepDependencies(boolean keep = true)
java.lang.Object label(java.lang.String labelExpression = null)
java.lang.Object logRotator(int daysToKeepInt = -1, int numToKeepInt = -1, int artifactDaysToKeepInt = -1, int artifactNumToKeepInt = -1)
java.lang.Object priority(int value)
java.lang.Object quietPeriod(int seconds = 5)
seconds
- number of seconds to wait
java.lang.Object runOnSameNodeAs(java.lang.String jobName, boolean useSameWorkspace = false)
jobName
- name of the jobuseSameWorkspace
- set to true
to share the workspace with the given job
java.lang.Object rvm(java.lang.String rubySpecification)
rubySpecification
- Specification of the required ruby version,
optionally containing a gemset
(i.e. ruby-1.9.3, ruby-2.0.0@gemset-foo)
Generates XML:
java.lang.Object sshAgent(java.lang.String credentials)
credentials
- name of the credentials to use
java.lang.Object timeout(java.lang.Integer timeoutInMinutes, java.lang.Boolean shouldFailBuild = true)
java.lang.Object timeout(java.lang.String type = absolute.toString(, groovy.lang.Closure timeoutClosure = null)
type
- type of timeout defaults to absolutetimeoutClosure
- optional closure for configuring the timeout
Groovy Documentation