DockerExecStopContainer (gradle-docker-plugin 6.7.0 API)

com.bmuschko.gradle.docker.tasks.container.extras.DockerExecStopContainer

Run an "exec" command on a container with the intent that it will gracefully stop the container from within. We will then poll for a given amount of time to check if the container is stopped and if not then attempt to issue a stop command on the container.
deprecated:
To be removed with the next major version without replacement

Inherited fields
Fields inherited from class	Fields
`class DefaultTask`	`TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS`

Properties Summary

Properties
Type	Name and description
`Property<Integer>`	`awaitStatusTimeout` Stop timeout in seconds.
`ExecProbe`	`execStopProbe`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`def`	`execStopProbe(long pollTime, long pollInterval)` Define the livenessProbe options for this exec/stop.
	`void`	`runRemoteCommand()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DockerExecContainer`	`doRunRemoteCommand, execProbe, runRemoteCommand, withCommand, withCommand`
`class DockerExistingContainer`	`targetContainerId, targetContainerId, targetContainerId`
`class AbstractDockerRemoteApiTask`	`getDockerClient, getNextHandler, getRegistryAuthLocator, onComplete, onError, onNext, runRemoteCommand, start`
`class DefaultTask`	getExtensions, getTimeout, setDescription, getProject, getIdentityPath, setGroup, getStandardOutputCapture, getAnt, getConvention, getLogging, getLogging, getDidWork, getAsDynamicObject, setActions, getTaskDependencies, getTaskDependencies, getDependsOn, setDependsOn, dependsOn, onlyIf, onlyIf, setOnlyIf, setOnlyIf, setDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, getEnabled, getOutputs, getOutputs, getDestroyables, getLocalState, getTemporaryDir, mustRunAfter, setMustRunAfter, getMustRunAfter, finalizedBy, setFinalizedBy, getFinalizedBy, shouldRunAfter, setShouldRunAfter, getShouldRunAfter, getTaskIdentity, injectIntoNewInstance, getTaskActions, hasTaskActions, getOnlyIf, getImpliesSubProjects, setImpliesSubProjects, replaceLogger, getTemporaryDirFactory, prependParallelSafeAction, appendParallelSafeAction, isHasCustomActions, getDescription, isEnabled, configure, configure, setEnabled, property, hasProperty, getGroup, getInputs, getInputs, toString, compareTo, compareTo, getName, setProperty, getLogger, getActions, getState, getState, getPath, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll

- Property Detail
  - @Input @Optional final Property<Integer> awaitStatusTimeout
    
    Stop timeout in seconds.
  - @Nested @Optional ExecProbe execStopProbe
- Method Detail
  - def execStopProbe(long pollTime, long pollInterval)
    
    Define the livenessProbe options for this exec/stop.
    Parameters:
    pollTime - how long we will poll for
    pollInterval - interval between poll requests
    Returns:
    instance of ExecProbe
  - @Override void runRemoteCommand()

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Class DockerExecStopContainer

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

@Input @Optional final Property<Integer> awaitStatusTimeout

@Nested @Optional ExecProbe execStopProbe

Method Detail

def execStopProbe(long pollTime, long pollInterval)

@Override void runRemoteCommand()