All Implemented Interfaces:: com.bmuschko.gradle.docker.tasks.RegistryCredentialsAware , kotlin.Comparable , org.gradle.api.Named , org.gradle.api.Task , org.gradle.api.internal.DynamicObjectAware , org.gradle.api.internal.TaskInternal , org.gradle.api.plugins.ExtensionAware , org.gradle.util.Configurable

@DisableCachingByDefault(because = "Pulls an image from a remote Docker registry into the local daemon - the effect is external to the build and must never be taken from the build cache") 
public abstract class AbstractPullImage
extends AbstractDockerRemoteApiTask implements RegistryCredentialsAware

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final Property<String>`	`image`
`private final Property<Boolean>`	`force`
`private final TaskOutputsInternal`	`outputs`
`private final Property<String>`	`apiVersion`
`private final Spec<in TaskInternal>`	`onlyIf`
`private final Property<Duration>`	`timeout`
`private final TaskRequiredServices`	`requiredServices`
`private final TaskDependencyInternal`	`taskDependencies`
`private final Set<Object>`	`dependsOn`
`private final TaskDestroyables`	`destroyables`
`private final Logger`	`logger`
`private final String`	`path`
`private final Factory<File>`	`temporaryDirFactory`
`private final Optional<String>`	`reasonTaskIsIncompatibleWithConfigurationCache`
`private final TaskLocalState`	`localState`
`private final List<InputChangesAwareTaskAction>`	`taskActions`
`private final TaskDependencyInternal`	`lifecycleDependencies`
`private Boolean`	`isEnabled`
`private Boolean`	`impliesSubProjects`
`private final TaskInputsInternal`	`inputs`
`private Boolean`	`enabled`
`private final TaskStateInternal`	`state`
`private final Property<String>`	`url`
`private final TaskIdentity<?>`	`taskIdentity`
`private final TaskDependency`	`shouldRunAfter`
`private final ExtensionContainer`	`extensions`
`private final Boolean`	`isCompatibleWithConfigurationCache`
`private final TaskDependency`	`finalizedBy`
`private final AntBuilder`	`ant`
`private final DynamicObject`	`asDynamicObject`
`private final List<ResourceLock>`	`sharedResources`
`private Boolean`	`didWork`
`private final Property<DockerClientService>`	`dockerClientService`
`private final Optional<String>`	`reasonNotToTrackState`
`private String`	`group`
`private final Set<String>`	`reasonsNotToTrackState`
`private final DockerRegistryCredentials`	`registryCredentials`
`private final Boolean`	`isHasCustomActions`
`private List<Action<in Task>>`	`actions`
`private final DirectoryProperty`	`certPath`
`private final String`	`name`
`private final File`	`temporaryDir`
`private final LoggingManager`	`logging`
`private final Path`	`identityPath`
`private final DockerClient`	`dockerClient`
`private final TaskDependency`	`mustRunAfter`
`private final StandardOutputCapture`	`standardOutputCapture`
`private final Project`	`project`
`private String`	`description`

Constructor Summary

Constructors
Constructor	Description
`AbstractPullImage(ObjectFactory objectFactory)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract Property<String>`	`getImage()`
`final Property<Boolean>`	`getForce()`
`Unit`	`registryCredentials(Action<in DockerRegistryCredentials> action)`	Configures the target Docker registry credentials for use with a task.
`final Unit`	`registryCredentials(Closure<DockerRegistryCredentials> c)`	Set the credentials for the task.
`DockerRegistryCredentials`	`getRegistryCredentials()`	The target Docker registry credentials for usage with a task.
`Unit`	`runRemoteCommand()`	Executes the remote Docker command.

Methods inherited from class com.intershop.gradle.icm.docker.tasks.AbstractPullImage
getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getRegistryCredentials, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, setActions, setDescription, setDidWork, setEnabled, setEnabled, setGroup
Methods inherited from class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
getApiVersion, getCertPath, getDockerClient, getDockerClientService, getUrl, onComplete, onError, onNext, start
Methods inherited from class org.gradle.api.internal.AbstractTask
getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getReasonsNotToTrackState, getRequiredServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, setImpliesSubProjects
Methods inherited from class org.gradle.api.Task
configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, doNotTrackState, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, notCompatibleWithConfigurationCache, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService
Methods inherited from class org.gradle.api.Named
getName
Methods inherited from class kotlin.Comparable
compareTo
Methods inherited from class org.gradle.api.plugins.ExtensionAware
getExtensions
Methods inherited from class org.gradle.api.internal.TaskInternal
acceptServiceReferences, appendParallelSafeAction, doNotTrackStateIf, hasTaskActions, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractPullImage
```
AbstractPullImage(ObjectFactory objectFactory)
```
- Method Detail
  - getImage
```
@Input() abstract Property<String> getImage()
```
  - getForce
```
@Input() final Property<Boolean> getForce()
```
  - registryCredentials
```
 Unit registryCredentials(Action<in DockerRegistryCredentials> action)
```
    Configures the target Docker registry credentials for use with a task.
    action 6.0.0
  - registryCredentials
```
 final Unit registryCredentials(Closure<DockerRegistryCredentials> c)
```
    Set the credentials for the task.
    
    Parameters:
    
    c - closure with Docker registry credentials.
  - getRegistryCredentials
```
 DockerRegistryCredentials getRegistryCredentials()
```
    The target Docker registry credentials for usage with a task.
  - runRemoteCommand
```
 Unit runRemoteCommand()
```
    Executes the remote Docker command.

Class AbstractPullImage

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class com.intershop.gradle.icm.docker.tasks.AbstractPullImage

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

Methods inherited from class org.gradle.api.internal.AbstractTask

Methods inherited from class org.gradle.api.Task

Methods inherited from class org.gradle.api.Named

Methods inherited from class kotlin.Comparable

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

Methods inherited from class org.gradle.api.internal.TaskInternal

Methods inherited from class java.lang.Object

Constructor Detail

AbstractPullImage

Method Detail

getImage

getForce

registryCredentials

registryCredentials

getRegistryCredentials

runRemoteCommand