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

Class DockerExistingContainer

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DockerCommitImage, DockerCopyFileFromContainer, DockerCopyFileToContainer, DockerExecContainer, DockerInspectContainer, DockerKillContainer, DockerLogsContainer, DockerRemoveContainer, DockerRenameContainer, DockerRestartContainer, DockerStartContainer, DockerStopContainer, DockerWaitContainer

public abstract class DockerExistingContainer
extends AbstractDockerRemoteApiTask

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
DockerExistingContainer()

Method Summary

Modifier and Type	Method	Description
final Property<String>	getContainerId()	The ID or name of container used to perform operation.
void	targetContainerId(String containerId)	Sets the target container ID or name.
void	targetContainerId(Callable<String> containerId)	Sets the target container ID or name.
void	targetContainerId(Provider<String> containerId)	Sets the target container ID or name.

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

getApiVersion, getCertPath, getDockerClient, getDockerClientService, getNextHandler, getRegistryAuthLocator, getUrl, onComplete, onError, onNext, runRemoteCommand, 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 Details

DockerExistingContainer

public DockerExistingContainer()

Method Details

getContainerId

@Input
public final Property<String> getContainerId()

The ID or name of container used to perform operation. The container for the provided ID has to be created first.

targetContainerId

public void targetContainerId(String containerId)

Sets the target container ID or name.

Parameters:

containerId - Container ID or name

See Also:

• targetContainerId(Callable)
• targetContainerId(Provider)

targetContainerId

public void targetContainerId(Callable<String> containerId)

Sets the target container ID or name.

Parameters:

containerId - Container ID or name as Callable

See Also:

• targetContainerId(String)
• targetContainerId(Provider)

targetContainerId

public void targetContainerId(Provider<String> containerId)

Sets the target container ID or name.

Parameters:

containerId - Container ID or name as Provider

See Also:

• targetContainerId(String)
• targetContainerId(Callable)