Package com.nirima.jenkins.plugins.docker.builder

Class DockerBuilderControlOptionRun

java.lang.Object

com.nirima.jenkins.plugins.docker.builder.DockerBuilderControlOption

com.nirima.jenkins.plugins.docker.builder.DockerBuilderControlCloudOption

com.nirima.jenkins.plugins.docker.builder.DockerBuilderControlOptionRun

All Implemented Interfaces:

Describable<DockerBuilderControlOption>, Serializable

public class DockerBuilderControlOptionRun
extends DockerBuilderControlCloudOption

Build step that allows run container through existed DockerCloud

Author:

magnayn

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DockerBuilderControlOptionRun.DescriptorImpl

Nested classes/interfaces inherited from class com.nirima.jenkins.plugins.docker.builder.DockerBuilderControlOption

DockerBuilderControlOption.DockerBuilderControlOptionDescriptor

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	bindAllPorts
final String	bindPorts
final String	cgroupParent
final Long	cpuPeriod
final Long	cpuQuota
final String	cpus
final Integer	cpuShares
final String	dnsSearchString
final String	dnsString
final String	dockerCommand
final String	environmentsString
final String	extraGroupsString
final String	hostname
final String	image
final String	macAddress
final Integer	memoryLimit
final Integer	memorySwap
final String	mountsString
final String	network
final boolean	privileged
final Integer	shmSize
final boolean	tty
final String	user
final String	volumesFrom

Fields inherited from class com.nirima.jenkins.plugins.docker.builder.DockerBuilderControlCloudOption

cloudName

Constructor Summary

Constructors

Constructor

Description

DockerBuilderControlOptionRun(String cloudName, String image, String pullCredentialsId, String dnsString, String dnsSearchString, String network, String dockerCommand, String mountsString, String volumesFrom, String environmentsString, String hostname, String user, String extraGroupsString, Integer memoryLimit, Integer memorySwap, String cgroupParent, String cpus, Long cpuPeriod, Long cpuQuota, Integer cpuShares, Integer shmSize, String bindPorts, boolean bindAllPorts, boolean privileged, boolean tty, String macAddress)

Method Summary

Modifier and Type	Method	Description
void	execute(Run<?,?> build, Launcher launcher, TaskListener listener)
org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint	getRegistry()

Methods inherited from class com.nirima.jenkins.plugins.docker.builder.DockerBuilderControlCloudOption

getCloud, getCloudName

Methods inherited from class com.nirima.jenkins.plugins.docker.builder.DockerBuilderControlOption

getDescriptor, getLaunchAction

Methods inherited from class java.lang.Object

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

Field Details

image

public final String image

dnsString

public final String dnsString

dnsSearchString

public final String dnsSearchString

network

public final String network

dockerCommand

public final String dockerCommand

mountsString

public final String mountsString

volumesFrom

public final String volumesFrom

environmentsString

public final String environmentsString

privileged

public final boolean privileged

tty

public final boolean tty

hostname

public final String hostname

user

public final String user

extraGroupsString

public final String extraGroupsString

bindPorts

public final String bindPorts

memoryLimit

public final Integer memoryLimit

memorySwap

public final Integer memorySwap

cgroupParent

public final String cgroupParent

cpus

public final String cpus

cpuPeriod

public final Long cpuPeriod

cpuQuota

public final Long cpuQuota

cpuShares

public final Integer cpuShares

shmSize

public final Integer shmSize

bindAllPorts

public final boolean bindAllPorts

macAddress

public final String macAddress

Constructor Details

DockerBuilderControlOptionRun

@DataBoundConstructor
public DockerBuilderControlOptionRun(String cloudName,
 String image,
 String pullCredentialsId,
 String dnsString,
 String dnsSearchString,
 String network,
 String dockerCommand,
 String mountsString,
 String volumesFrom,
 String environmentsString,
 String hostname,
 String user,
 String extraGroupsString,
 Integer memoryLimit,
 Integer memorySwap,
 String cgroupParent,
 String cpus,
 Long cpuPeriod,
 Long cpuQuota,
 Integer cpuShares,
 Integer shmSize,
 String bindPorts,
 boolean bindAllPorts,
 boolean privileged,
 boolean tty,
 String macAddress)

Method Details

getRegistry

public org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint getRegistry()

execute

public void execute(Run<?,?> build,
 Launcher launcher,
 TaskListener listener)
             throws com.github.dockerjava.api.exception.DockerException,
IOException

Specified by:

execute in class DockerBuilderControlOption

Throws:

com.github.dockerjava.api.exception.DockerException

IOException