All Implemented Interfaces:: kotlin.Comparable , org.gradle.api.Named , org.gradle.api.Task , org.gradle.api.internal.DynamicObjectAware , org.gradle.api.internal.TaskInternal , org.gradle.api.plugins.ExtensionAware , org.gradle.util.Configurable

@DisableCachingByDefault(because = "Interacts with a live Docker daemon - container, image, network and volume state is external to the build and must never be taken from the build cache") 
public abstract class StartExtraContainer
extends AbstractExistingContainerTask

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final Property<String>`	`finishedCheck`
`private final Property<Duration>`	`startupTimeout`
`private final ListProperty<ProbeSpec>`	`probeSpecs`
`private final Property<Boolean>`	`enableLogWatcher`
`private final Property<ContainerHandle>`	`container`
`private final TaskOutputsInternal`	`outputs`
`private final Property<String>`	`apiVersion`
`private final Spec<in TaskInternal>`	`onlyIf`
`private final Property<Duration>`	`timeout`
`private final TaskRequiredServices`	`requiredServices`
`private final TaskDependencyInternal`	`taskDependencies`
`private final Set<Object>`	`dependsOn`
`private final TaskDestroyables`	`destroyables`
`private final Logger`	`logger`
`private final String`	`path`
`private final Factory<File>`	`temporaryDirFactory`
`private final Optional<String>`	`reasonTaskIsIncompatibleWithConfigurationCache`
`private final TaskLocalState`	`localState`
`private final List<InputChangesAwareTaskAction>`	`taskActions`
`private final TaskDependencyInternal`	`lifecycleDependencies`
`private Boolean`	`isEnabled`
`private Boolean`	`impliesSubProjects`
`private final TaskInputsInternal`	`inputs`
`private Boolean`	`enabled`
`private final TaskStateInternal`	`state`
`private final Property<String>`	`url`
`private final TaskIdentity<?>`	`taskIdentity`
`private final TaskDependency`	`shouldRunAfter`
`private final ExtensionContainer`	`extensions`
`private final Boolean`	`isCompatibleWithConfigurationCache`
`private final TaskDependency`	`finalizedBy`
`private final AntBuilder`	`ant`
`private final DynamicObject`	`asDynamicObject`
`private final List<ResourceLock>`	`sharedResources`
`private Boolean`	`didWork`
`private final Property<DockerClientService>`	`dockerClientService`
`private final Optional<String>`	`reasonNotToTrackState`
`private String`	`group`
`private final Set<String>`	`reasonsNotToTrackState`
`private final Boolean`	`isHasCustomActions`
`private List<Action<in Task>>`	`actions`
`private final DirectoryProperty`	`certPath`
`private final String`	`name`
`private final File`	`temporaryDir`
`private final LoggingManager`	`logging`
`private final Path`	`identityPath`
`private final DockerClient`	`dockerClient`
`private final TaskDependency`	`mustRunAfter`
`private final StandardOutputCapture`	`standardOutputCapture`
`private final Project`	`project`
`private String`	`description`

Constructor Summary

Constructors
Constructor	Description
`StartExtraContainer(ObjectFactory objectFactory, ProviderFactory providerFactory, ProgressLoggerFactory progressLoggerFactory)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Property<String>`	`getFinishedCheck()`	Set a string for log file check.
`final Property<Duration>`	`getStartupTimeout()`	Max duration for the container to start up (only evaluated if finishedCheck is set)
`final ListProperty<ProbeSpec>`	`getProbeSpecs()`	Descriptions of the probes verifying that the container started properly.
`final Property<Boolean>`	`getEnableLogWatcher()`
`final Unit`	`withHttpProbe(URI uri, Duration retryInterval, Duration retryTimeout)`
`final Unit`	`withSocketProbe(Integer port, Duration retryInterval, Duration retryTimeout)`
`final Unit`	`withProbeSpecs(ProbeSpec probeSpecs)`	Configures this task to (additionally) use the probes described by `probeSpecs`
`Unit`	`runRemoteCommand()`

Methods inherited from class com.intershop.gradle.icm.docker.tasks.AbstractContainerTask
currentContainerState, getContainer, getContainer
Methods inherited from class org.gradle.api.DefaultTask
getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, setActions, setDescription, setDidWork, setEnabled, setEnabled, setGroup
Methods inherited from class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
getApiVersion, getCertPath, getDockerClient, getDockerClientService, getUrl, onComplete, onError, onNext, start
Methods inherited from class org.gradle.api.internal.AbstractTask
getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getReasonsNotToTrackState, getRequiredServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, setImpliesSubProjects
Methods inherited from class com.intershop.gradle.icm.docker.tasks.AbstractExistingContainerTask
executeUsing
Methods inherited from class org.gradle.api.Task
configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, doNotTrackState, finalizedBy, hasProperty, mustRunAfter, notCompatibleWithConfigurationCache, onlyIf, onlyIf, onlyIf, property, setDependsOn, setFinalizedBy, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService
Methods inherited from class kotlin.Comparable
compareTo
Methods inherited from class org.gradle.api.internal.TaskInternal
acceptServiceReferences, appendParallelSafeAction, doNotTrackStateIf, hasTaskActions, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StartExtraContainer
```
StartExtraContainer(ObjectFactory objectFactory, ProviderFactory providerFactory, ProgressLoggerFactory progressLoggerFactory)
```
- Method Detail
  - getFinishedCheck
```
@Optional()@Input() final Property<String> getFinishedCheck()
```
    Set a string for log file check. Log is displayed as long the string was not part of the output.
  - getStartupTimeout
```
@Input() final Property<Duration> getStartupTimeout()
```
    Max duration for the container to start up (only evaluated if finishedCheck is set)
  - getProbeSpecs
```
@Input() final ListProperty<ProbeSpec> getProbeSpecs()
```
    Descriptions of the probes verifying that the container started properly.
    Holds the descriptions rather than the com.intershop.gradle.icm.utils.Probes themselves: a probe carries a logger and an HTTP client, which Gradle can neither snapshot as a task input nor store in the configuration cache. The probes are created from these descriptions while the task executes.
  - getEnableLogWatcher
```
@Input() final Property<Boolean> getEnableLogWatcher()
```
  - withHttpProbe
```
 final Unit withHttpProbe(URI uri, Duration retryInterval, Duration retryTimeout)
```
  - withSocketProbe
```
 final Unit withSocketProbe(Integer port, Duration retryInterval, Duration retryTimeout)
```
  - withProbeSpecs
```
 final Unit withProbeSpecs(ProbeSpec probeSpecs)
```
    Configures this task to (additionally) use the probes described by probeSpecs
  - runRemoteCommand
```
 Unit runRemoteCommand()
```

Class StartExtraContainer

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class com.intershop.gradle.icm.docker.tasks.AbstractContainerTask

Methods inherited from class org.gradle.api.DefaultTask

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

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

Methods inherited from class com.intershop.gradle.icm.docker.tasks.AbstractExistingContainerTask

Methods inherited from class org.gradle.api.Task

Methods inherited from class kotlin.Comparable

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

Methods inherited from class java.lang.Object

Constructor Detail

StartExtraContainer

Method Detail

getFinishedCheck

getStartupTimeout

getProbeSpecs

getEnableLogWatcher

withHttpProbe

withSocketProbe

withProbeSpecs

runRemoteCommand