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

Class DockerPullImage

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask

com.bmuschko.gradle.docker.tasks.image.DockerPullImage

All Implemented Interfaces:

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

public class DockerPullImage
extends AbstractDockerRemoteApiTask
implements RegistryCredentialsAware

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

Method Summary

Modifier and Type	Method	Description
final Property<String>	getImage()	The image including repository, image name and tag to be pulled e.g.
final Property<String>	getPlatform()	The target platform in the format os[/arch[/variant]], for example linux/s390x or darwin.
final DockerRegistryCredentials	getRegistryCredentials()	The target Docker registry credentials for usage with a task.
void	registryCredentials(Action<? super DockerRegistryCredentials> action)	Configures the target Docker registry credentials for use with a task.
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 java.lang.Comparable

compareTo

Methods inherited from interface org.gradle.api.plugins.ExtensionAware

getExtensions

Methods inherited from interface org.gradle.api.Task

configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, doNotTrackState, finalizedBy, getActions, getAnt, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getFinalizedBy, getGroup, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getPath, getProject, getShouldRunAfter, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, notCompatibleWithConfigurationCache, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Constructor Details

DockerPullImage

public DockerPullImage()

Method Details

getImage

@Input
public final Property<String> getImage()

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

Since:

6.0.0

getPlatform

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

The target platform in the format os[/arch[/variant]], for example linux/s390x or darwin.

Since:

7.1.0

getRegistryCredentials

public final DockerRegistryCredentials getRegistryCredentials()

The target Docker registry credentials for usage with a task.

Specified by:

getRegistryCredentials in interface RegistryCredentialsAware

runRemoteCommand

public void runRemoteCommand()
                      throws InterruptedException

Specified by:

runRemoteCommand in class AbstractDockerRemoteApiTask

Throws:

InterruptedException

registryCredentials

public void registryCredentials(Action<? super DockerRegistryCredentials> action)

Configures the target Docker registry credentials for use with a task.

Specified by:

registryCredentials in interface RegistryCredentialsAware

Parameters:

action - The action against the Docker registry credentials