Package org.jenkinsci.plugins.dockerbuildstep.cmd

Class CreateContainerCommand

java.lang.Object

org.jenkinsci.plugins.dockerbuildstep.cmd.DockerCommand

org.jenkinsci.plugins.dockerbuildstep.cmd.CreateContainerCommand

All Implemented Interfaces:

ExtensionPoint, Describable<DockerCommand>

public class CreateContainerCommand
extends DockerCommand

This command creates new container from specified image.

Author:

vjuranek

See Also:

• https://docs.docker.com/engine/api/v1.37/#operation/ContainerCreate
• https://docs.docker.com/engine/api/v1.18/#21-containers

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateContainerCommand.CreateContainerCommandDescriptor

Nested classes/interfaces inherited from class org.jenkinsci.plugins.dockerbuildstep.cmd.DockerCommand

DockerCommand.DockerCommandDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class org.jenkinsci.plugins.dockerbuildstep.cmd.DockerCommand

CREDENTIALS_MATCHER

Constructor Summary

Constructors

Constructor	Description
CreateContainerCommand(String image, String command, String hostName, String containerName, String envVars, String links, String exposedPorts, String cpuShares, String memoryLimit, String dns, String extraHosts, String networkMode, boolean publishAllPorts, String portBindings, String bindMounts, boolean privileged, boolean alwaysRestart)

Method Summary

Modifier and Type	Method	Description
void	execute(Launcher launcher, AbstractBuild build, ConsoleLogger console)
String	getBindMounts()
String	getCommand()
String	getContainerName()
String	getCpuShares()
String	getDns()
String	getEnvVars()
String	getExposedPorts()
String	getExtraHosts()
String	getHostName()
String	getImage()
String	getLinks()
String	getMemoryLimit()
String	getNetworkMode()
String	getPortBindings()
boolean	getPrivileged()
boolean	getPublishAllPorts()
boolean	isAlwaysRestart()
boolean	isPrivileged()
boolean	isPublishAllPorts()

Methods inherited from class org.jenkinsci.plugins.dockerbuildstep.cmd.DockerCommand

all, attachContainerOutput, getAuthConfig, getClient, getClient, getConfig, getDescriptor, getDockerRegistryEndpoint, getInfoString, readResolve

Methods inherited from class java.lang.Object

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

Constructor Details

CreateContainerCommand

@DataBoundConstructor
public CreateContainerCommand(String image,
 String command,
 String hostName,
 String containerName,
 String envVars,
 String links,
 String exposedPorts,
 String cpuShares,
 String memoryLimit,
 String dns,
 String extraHosts,
 String networkMode,
 boolean publishAllPorts,
 String portBindings,
 String bindMounts,
 boolean privileged,
 boolean alwaysRestart)
                       throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Details

getImage

public String getImage()

getCommand

public String getCommand()

getHostName

public String getHostName()

getContainerName

public String getContainerName()

getEnvVars

public String getEnvVars()

getLinks

public String getLinks()

getExposedPorts

public String getExposedPorts()

getCpuShares

public String getCpuShares()

getMemoryLimit

public String getMemoryLimit()

getDns

public String getDns()

getExtraHosts

public String getExtraHosts()

getNetworkMode

public String getNetworkMode()

isPublishAllPorts

public boolean isPublishAllPorts()

isPrivileged

public boolean isPrivileged()

getPublishAllPorts

public boolean getPublishAllPorts()

getPortBindings

public String getPortBindings()

getBindMounts

public String getBindMounts()

getPrivileged

public boolean getPrivileged()

isAlwaysRestart

public boolean isAlwaysRestart()

execute

public void execute(Launcher launcher,
 AbstractBuild build,
 ConsoleLogger console)
             throws com.github.dockerjava.api.exception.DockerException

Specified by:

execute in class DockerCommand

Throws:

com.github.dockerjava.api.exception.DockerException