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

Class DockerCommitImage

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

com.bmuschko.gradle.docker.tasks.image.DockerCommitImage

All Implemented Interfaces:

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

public class DockerCommitImage
extends DockerExistingContainer

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

Method Summary

Modifier and Type	Method	Description
final Property<Boolean>	getAttachStderr()
final Property<Boolean>	getAttachStdin()
final Property<String>	getAuthor()	Author of image e.g.
final Property<String>	getImageId()	The ID of the image committed.
final RegularFileProperty	getImageIdFile()	Output file containing the image ID of the image committed.
final Property<String>	getMessage()	Commit message.
final Property<Boolean>	getPause()
final Property<String>	getRepository()	The repository and image name e.g.
final Property<String>	getTag()	The tag e.g.
void	runRemoteCommand()

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

getContainerId, targetContainerId, targetContainerId, targetContainerId

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

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

DockerCommitImage

public DockerCommitImage()

Method Details

getRepository

@Input
public final Property<String> getRepository()

The repository and image name e.g. vieux/apache.

Since:

9.0.0

getTag

@Input
public final Property<String> getTag()

The tag e.g. 2.0.

Since:

9.0.0

getMessage

@Input
@Optional
public final Property<String> getMessage()

Commit message.

getAuthor

@Input
@Optional
public final Property<String> getAuthor()

Author of image e.g. Benjamin Muschko.

getPause

@Input
@Optional
public final Property<Boolean> getPause()

getAttachStderr

@Input
@Optional
public final Property<Boolean> getAttachStderr()

getAttachStdin

@Input
@Optional
public final Property<Boolean> getAttachStdin()

getImageIdFile

@OutputFile
public final RegularFileProperty getImageIdFile()

Output file containing the image ID of the image committed. Defaults to "$buildDir/.docker/$taskpath-imageId.txt". If path contains ':' it will be replaced by '_'.

getImageId

@Internal
public final Property<String> getImageId()

The ID of the image committed. The value of this property requires the task action to be executed.

runRemoteCommand

public void runRemoteCommand()
                      throws IOException

Specified by:

runRemoteCommand in class AbstractDockerRemoteApiTask

Throws:

IOException