Package com.bmuschko.gradle.docker.tasks.container

Class DockerExecContainer

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask

com.bmuschko.gradle.docker.tasks.container.DockerExistingContainer

com.bmuschko.gradle.docker.tasks.container.DockerExecContainer

All Implemented Interfaces:

Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, Configurable<Task>

public class DockerExecContainer
extends DockerExistingContainer

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor	Description
DockerExecContainer()

Method Summary

Modifier and Type	Method	Description
protected void	doRunRemoteCommand(com.github.dockerjava.api.DockerClient dockerClient)
ExecProbe	execProbe(long pollTime, long pollInterval)	Define the livenessProbe options for this exec.
Property<Boolean>	getAttachStderr()
Property<Boolean>	getAttachStdout()
ListProperty<String[]>	getCommands()
ListProperty<String>	getExecIds()
ExecProbe	getExecProbe()
ListProperty<Integer>	getSuccessOnExitCodes()
Property<String>	getUser()	Username or UID to execute the command as, with optional colon separated group or gid in format: <name|uid>[:<group|gid>]
Property<String>	getWorkingDir()	Working directory in which the command is going to be executed.
void	runRemoteCommand()
void	setExecProbe(ExecProbe execProbe)
void	withCommand(String[] commandsToExecute)	Deprecated. Use the method named getCommands() directly
void	withCommand(List<String> commandsToExecute)	Deprecated. Use the method named getCommands() directly

Methods inherited from class com.bmuschko.gradle.docker.tasks.container.DockerExistingContainer

getContainerId, targetContainerId, targetContainerId, targetContainerId

Methods inherited from class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask

getApiVersion, getCertPath, getDockerClient, getDockerClientService, getNextHandler, getRegistryAuthLocator, getUrl, onComplete, onError, onNext, start

Methods inherited from class org.gradle.api.DefaultTask

compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Methods inherited from class org.gradle.api.internal.AbstractTask

appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gradle.api.Task

doNotTrackState, getConvention, notCompatibleWithConfigurationCache

Constructor Detail

DockerExecContainer

public DockerExecContainer()

Method Detail

getCommands

@Input
@Optional
public final ListProperty<String[]> getCommands()

getAttachStdout

@Input
@Optional
public final Property<Boolean> getAttachStdout()

getAttachStderr

@Input
@Optional
public final Property<Boolean> getAttachStderr()

getUser

@Input
@Optional
public final Property<String> getUser()

Username or UID to execute the command as, with optional colon separated group or gid in format: <name|uid>[:<group|gid>]

Since:

3.2.8

getWorkingDir

@Input
@Optional
public final Property<String> getWorkingDir()

Working directory in which the command is going to be executed. Defaults to the WORKDIR set in docker file.

Since:

6.3.0

getSuccessOnExitCodes

@Input
@Optional
public final ListProperty<Integer> getSuccessOnExitCodes()

getExecProbe

@Optional
public ExecProbe getExecProbe()

setExecProbe

public void setExecProbe(ExecProbe execProbe)

getExecIds

@Internal
public final ListProperty<String> getExecIds()

runRemoteCommand

public void runRemoteCommand()
                      throws InterruptedException

Specified by:

runRemoteCommand in class AbstractDockerRemoteApiTask

Throws:

InterruptedException

doRunRemoteCommand

protected void doRunRemoteCommand(com.github.dockerjava.api.DockerClient dockerClient)
                           throws InterruptedException

Throws:

InterruptedException

withCommand

@Deprecated
public void withCommand(List<String> commandsToExecute)

Deprecated.

Use the method named getCommands() directly

Convenience method for adding commands.

Parameters:

commandsToExecute - The commands to execute

withCommand

@Deprecated
public void withCommand(String[] commandsToExecute)

Deprecated.

Use the method named getCommands() directly

Convenience method for adding commands.

Parameters:

commandsToExecute - The commands to execute

execProbe

public ExecProbe execProbe(long pollTime,
                           long pollInterval)

Define the livenessProbe options for this exec.

Parameters:

pollTime - how long we will poll for

pollInterval - interval between poll requests

Returns:

instance of ExecProbe