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 CreateExtraContainer
extends DockerCreateContainer

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final Property<ContainerHandle>`	`existingContainer`
`private final Property<ContainerHandle>`	`createdContainer`
`private final TaskOutputsInternal`	`outputs`
`private final Property<String>`	`apiVersion`
`private final Property<String>`	`platform`
`private final Spec<in TaskInternal>`	`onlyIf`
`private final Property<Duration>`	`timeout`
`private final TaskRequiredServices`	`requiredServices`
`private final ListProperty<String>`	`volumes`
`private final Property<Boolean>`	`attachStderr`
`private final TaskDependencyInternal`	`taskDependencies`
`private final Set<Object>`	`dependsOn`
`private final Property<Boolean>`	`tty`
`private final DockerCreateContainer.HealthCheckConfig`	`healthCheck`
`private final TaskDestroyables`	`destroyables`
`private final Logger`	`logger`
`private final Property<String>`	`macAddress`
`private final Property<String>`	`containerId`
`private final String`	`path`
`private final Factory<File>`	`temporaryDirFactory`
`private final Optional<String>`	`reasonTaskIsIncompatibleWithConfigurationCache`
`private final ListProperty<String>`	`cmd`
`private final Property<String>`	`imageId`
`private final ListProperty<String>`	`networkAliases`
`private final TaskLocalState`	`localState`
`private final List<InputChangesAwareTaskAction>`	`taskActions`
`private final ListProperty<String>`	`portSpecs`
`private final TaskDependencyInternal`	`lifecycleDependencies`
`private final ListProperty<String>`	`entrypoint`
`private Boolean`	`isEnabled`
`private Boolean`	`impliesSubProjects`
`private final Property<String>`	`user`
`private final TaskInputsInternal`	`inputs`
`private Boolean`	`enabled`
`private final TaskStateInternal`	`state`
`private final DockerCreateContainer.HostConfig`	`hostConfig`
`private final Property<Boolean>`	`attachStdout`
`private final Property<String>`	`url`
`private final Property<String>`	`workingDir`
`private final TaskIdentity<?>`	`taskIdentity`
`private final Property<String>`	`hostName`
`private final TaskDependency`	`shouldRunAfter`
`private final ExtensionContainer`	`extensions`
`private final Boolean`	`isCompatibleWithConfigurationCache`
`private final TaskDependency`	`finalizedBy`
`private final Property<Boolean>`	`stdinOnce`
`private final AntBuilder`	`ant`
`private final DynamicObject`	`asDynamicObject`
`private final List<ResourceLock>`	`sharedResources`
`private Boolean`	`didWork`
`private final ListProperty<DockerCreateContainer.ExposedPort>`	`exposedPorts`
`private final Property<DockerClientService>`	`dockerClientService`
`private final Optional<String>`	`reasonNotToTrackState`
`private final MapProperty<String, String>`	`labels`
`private final Property<String>`	`containerName`
`private String`	`group`
`private final Set<String>`	`reasonsNotToTrackState`
`private final Property<String>`	`image`
`private final Property<String>`	`pid`
`private final Boolean`	`isHasCustomActions`
`private final Property<Boolean>`	`stdinOpen`
`private final RegularFileProperty`	`containerIdFile`
`private final Property<Boolean>`	`attachStdin`
`private List<Action<in Task>>`	`actions`
`private final DirectoryProperty`	`certPath`
`private final MapProperty<String, String>`	`envVars`
`private final String`	`name`
`private final Property<String>`	`ipv4Address`
`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
`CreateExtraContainer(ObjectFactory objectFactory, ProviderFactory providerFactory)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Property<ContainerHandle>`	`getExistingContainer()`
`final Property<ContainerHandle>`	`getCreatedContainer()`
`final Provider<PortMapping>`	`getPrimaryPortMapping()`	Returns a Provider that provides the primary port mapping if there is such a port mapping otherwise Provider.get will fail
`final Set<PortMapping>`	`getPortMappings()`	Returns all port mappings
`final Unit`	`withPortMappings(PortMapping portMappings)`	Adds port mappings to be used with the container
`final Unit`	`withEnvironment(ContainerEnvironment environment)`	Same as CreateExtraContainer.
`final Unit`	`withEnvironment(Provider<ContainerEnvironment> environment)`	Applies the given `environment` to this task's DockerCreateContainer.envVars (using MapProperty.putAll).
`final Unit`	`withVolumes(Map<String, String> volumes)`
`final Unit`	`withVolumes(Provider<Map<String, String>> volumes)`
`Unit`	`runRemoteCommand()`

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 com.bmuschko.gradle.docker.tasks.container.DockerCreateContainer
exposePorts, getAttachStderr, getAttachStdin, getAttachStdout, getCmd, getContainerId, getContainerIdFile, getContainerName, getEntrypoint, getEnvVars, getExposedPorts, getHealthCheck, getHostConfig, getHostName, getImage, getIpv4Address, getLabels, getMacAddress, getNetworkAliases, getPid, getPlatform, getPortSpecs, getStdinOnce, getStdinOpen, getTty, getUser, getVolumes, getWorkingDir, withEnvVar
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.bmuschko.gradle.docker.tasks.image.DockerExistingImage
getImageId, targetImageId, targetImageId, targetImageId
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

CreateExtraContainer

CreateExtraContainer(ObjectFactory objectFactory, ProviderFactory providerFactory)

Method Detail

getExistingContainer

@Internal() final Property<ContainerHandle> getExistingContainer()

getCreatedContainer

@Internal() final Property<ContainerHandle> getCreatedContainer()

getPrimaryPortMapping
```
@Internal() final Provider<PortMapping> getPrimaryPortMapping()
```
Returns a Provider that provides the primary port mapping if there is such a port mapping otherwise Provider.get will fail

getPortMappings

@Internal() final Set<PortMapping> getPortMappings()

Returns all port mappings

withPortMappings
```
 final Unit withPortMappings(PortMapping portMappings)
```
Adds port mappings to be used with the container

withEnvironment
```
 final Unit withEnvironment(ContainerEnvironment environment)
```
Same as CreateExtraContainer.withEnvironment(Provider<ContainerEnvironment>) but using a Provider<ContainerEnvironment>

withEnvironment
```
 final Unit withEnvironment(Provider<ContainerEnvironment> environment)
```
Applies the given environment to this task's DockerCreateContainer.envVars (using MapProperty.putAll).

withVolumes

 final Unit withVolumes(Map<String, String> volumes)

withVolumes

 final Unit withVolumes(Provider<Map<String, String>> volumes)

runRemoteCommand
```
 Unit runRemoteCommand()
```

Class CreateExtraContainer

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class org.gradle.api.DefaultTask

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

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

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

Methods inherited from class com.bmuschko.gradle.docker.tasks.image.DockerExistingImage

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

CreateExtraContainer

Method Detail

getExistingContainer

getCreatedContainer

getPrimaryPortMapping

getPortMappings

withPortMappings

withEnvironment

withEnvironment

withVolumes

withVolumes

runRemoteCommand