Package org.jenkinsci.plugins.docker.workflow.declarative

Class AbstractDockerAgent<D extends AbstractDockerAgent<D>>

java.lang.Object

hudson.model.AbstractDescribableImpl<T>

org.jenkinsci.plugins.pipeline.modeldefinition.withscript.WithScriptDescribable<A>

org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgent<D>

org.jenkinsci.plugins.docker.workflow.declarative.AbstractDockerAgent<D>

All Implemented Interfaces:

ExtensionPoint, Describable<D>, Serializable

Direct Known Subclasses:

DockerPipeline, DockerPipelineFromDockerfile

public abstract class AbstractDockerAgent<D extends AbstractDockerAgent<D>>
extends org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgent<D>

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractDockerAgent.ChangelogConditionalScriptAllowlist	AbstractDockerPipelineScript.groovy is a superclass of the Groovy scripts for subclasses of AbstractDockerAgent, but does not have any direct equivalent Java class, so we just allow it here.

Nested classes/interfaces inherited from class org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgent

org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgent.CheckoutScriptAllowlist

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
protected String	args
protected boolean	containerPerStageRoot
protected String	customWorkspace
protected String	label
protected String	registryCredentialsId
protected String	registryUrl
protected boolean	reuseNode

Fields inherited from class org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgent

doCheckout, inStage, subdirectory

Constructor Summary

Constructors

Constructor	Description
AbstractDockerAgent()

Method Summary

Modifier and Type	Method	Description
String	getArgs()
String	getCustomWorkspace()
String	getLabel()
String	getRegistryCredentialsId()
String	getRegistryUrl()
boolean	getReuseNode()
void	initialize(Map<String,org.jenkinsci.plugins.pipeline.modeldefinition.options.DeclarativeOption> options, boolean explicitAgentInStage)
boolean	isContainerPerStageRoot()
boolean	reuseRootAgent(Map<String,org.jenkinsci.plugins.pipeline.modeldefinition.options.DeclarativeOption> options)
void	setArgs(String args)
void	setContainerPerStageRoot(boolean containerPerStageRoot)
void	setCustomWorkspace(String customWorkspace)
void	setLabel(String label)
void	setRegistryCredentialsId(String registryCredentialsId)
void	setRegistryUrl(String registryUrl)
void	setReuseNode(boolean reuseNode)

Methods inherited from class org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgent

copyFlags, getDescriptor, getScript, getSubdirectory, hasScmContext, isDoCheckout, isInStage, setDoCheckout, setInStage, setSubdirectory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

label

protected String label

args

protected String args

registryUrl

protected String registryUrl

registryCredentialsId

protected String registryCredentialsId

customWorkspace

protected String customWorkspace

reuseNode

protected boolean reuseNode

containerPerStageRoot

protected boolean containerPerStageRoot

Constructor Details

AbstractDockerAgent

public AbstractDockerAgent()

Method Details

getRegistryUrl

@Nullable
public String getRegistryUrl()

setRegistryUrl

@DataBoundSetter
public void setRegistryUrl(String registryUrl)

getRegistryCredentialsId

@Nullable
public String getRegistryCredentialsId()

setRegistryCredentialsId

@DataBoundSetter
public void setRegistryCredentialsId(String registryCredentialsId)

getReuseNode

public boolean getReuseNode()

setReuseNode

@DataBoundSetter
public void setReuseNode(boolean reuseNode)

getLabel

@CheckForNull
public String getLabel()

setLabel

@DataBoundSetter
public void setLabel(String label)

getCustomWorkspace

@CheckForNull
public String getCustomWorkspace()

setCustomWorkspace

@DataBoundSetter
public void setCustomWorkspace(String customWorkspace)

getArgs

@CheckForNull
public String getArgs()

setArgs

@DataBoundSetter
public void setArgs(String args)

isContainerPerStageRoot

public boolean isContainerPerStageRoot()

setContainerPerStageRoot

@DataBoundSetter
public void setContainerPerStageRoot(boolean containerPerStageRoot)

initialize

public void initialize(Map<String,org.jenkinsci.plugins.pipeline.modeldefinition.options.DeclarativeOption> options,
 boolean explicitAgentInStage)

Overrides:

initialize in class org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgent<D extends AbstractDockerAgent<D>>

reuseRootAgent

public boolean reuseRootAgent(Map<String,org.jenkinsci.plugins.pipeline.modeldefinition.options.DeclarativeOption> options)

Overrides:

reuseRootAgent in class org.jenkinsci.plugins.pipeline.modeldefinition.agent.DeclarativeAgent<D extends AbstractDockerAgent<D>>