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

Class DockerSaveImage

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask

com.bmuschko.gradle.docker.tasks.image.DockerSaveImage

All Implemented Interfaces:

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

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

Method Summary

Modifier and Type	Method	Description
final RegularFileProperty	getDestFile()	Where to save image.
final RegularFileProperty	getImageIdsFile()	Output file containing the image IDs of the saved images.
final SetProperty<String>	getImages()	The images including repository, image name and tag to be saved e.g.
final Property<Boolean>	getUseCompression()
void	runRemoteCommand()

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

DockerSaveImage

public DockerSaveImage()

Method Details

getImages

@Input
public final SetProperty<String> getImages()

The images including repository, image name and tag to be saved e.g. vieux/apache:2.0.

Since:

8.0.0

getUseCompression

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

getDestFile

@OutputFile
public final RegularFileProperty getDestFile()

Where to save image.

getImageIdsFile

@OutputFile
public final RegularFileProperty getImageIdsFile()

Output file containing the image IDs of the saved images. Defaults to "$buildDir/.docker/$taskpath-imageIds.properties". If path contains ':' it will be replaced by '_'.

Since:

8.0.0

runRemoteCommand

public void runRemoteCommand()

Specified by:

runRemoteCommand in class AbstractDockerRemoteApiTask