Package com.bmuschko.gradle.docker.tasks.image

Class DockerExistingImage

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask

com.bmuschko.gradle.docker.tasks.image.DockerExistingImage

All Implemented Interfaces:

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

Direct Known Subclasses:

DockerCreateContainer, DockerInspectImage, DockerRemoveImage, DockerTagImage

public abstract class DockerExistingImage
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
DockerExistingImage()

Method Summary

Modifier and Type	Method	Description
Property<String>	getImageId()	The ID or name of image used to perform operation.
void	targetImageId(String imageId)	Sets the target image ID or name.
void	targetImageId(Callable<String> imageId)	Sets the target image ID or name.
void	targetImageId(Provider<String> imageId)	Sets the target image 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 Detail

DockerExistingImage

public DockerExistingImage()

Method Detail

getImageId

@Input
public final Property<String> getImageId()

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

targetImageId

public void targetImageId(String imageId)

Sets the target image ID or name.

Parameters:

imageId - Image ID or name

See Also:

targetImageId(Callable), targetImageId(Provider)

targetImageId

public void targetImageId(Callable<String> imageId)

Sets the target image ID or name.

Parameters:

imageId - Image ID or name as Callable

See Also:

targetImageId(String), targetImageId(Provider)

targetImageId

public void targetImageId(Provider<String> imageId)

Sets the target image ID or name.

Parameters:

imageId - Image ID or name as Provider

See Also:

targetImageId(String), targetImageId(Callable)