AbstractDockerRemoteApiTask (gradle-docker-plugin 6.7.0 API)

com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask

Inherited fields
Fields inherited from class	Fields
`class DefaultTask`	`TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS`
`class AbstractTask`	`TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS`

Properties Summary

Properties
Type	Name and description
`Property<String>`	`apiVersion` The Docker remote API version.
`DirectoryProperty`	`certPath` Path to the Docker certificate and key.
`Property<String>`	`url` Docker remote API server URL.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`com.github.dockerjava.api.DockerClient`	`getDockerClient()` Gets the Docker client uses to communicate with Docker via its remote API.
	`protected Action`	`getNextHandler()`
	`protected RegistryAuthLocator`	`getRegistryAuthLocator()` Returns the instance of RegistryAuthLocator.
	`void`	`onComplete(Runnable callback)` Reacts to the completion of the operation.
	`void`	`onError(Action<? super Throwable> action)` Reacts to a potential error occurring during the operation.
	`void`	`onNext(Action action)` Reacts to data returned by an operation.
	`void`	`runRemoteCommand()`
	`void`	`start()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DefaultTask`	getExtensions, getTimeout, setDescription, getProject, getIdentityPath, setGroup, getStandardOutputCapture, getAnt, getConvention, getLogging, getLogging, getDidWork, getAsDynamicObject, setActions, getTaskDependencies, getTaskDependencies, getDependsOn, setDependsOn, dependsOn, onlyIf, onlyIf, setOnlyIf, setOnlyIf, setDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, getEnabled, getOutputs, getOutputs, getDestroyables, getLocalState, getTemporaryDir, mustRunAfter, setMustRunAfter, getMustRunAfter, finalizedBy, setFinalizedBy, getFinalizedBy, shouldRunAfter, setShouldRunAfter, getShouldRunAfter, getTaskIdentity, injectIntoNewInstance, getTaskActions, hasTaskActions, getOnlyIf, getImpliesSubProjects, setImpliesSubProjects, replaceLogger, getTemporaryDirFactory, prependParallelSafeAction, appendParallelSafeAction, isHasCustomActions, getDescription, isEnabled, configure, configure, setEnabled, property, hasProperty, getGroup, getInputs, getInputs, toString, compareTo, compareTo, getName, setProperty, getLogger, getActions, getState, getState, getPath, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll
`class AbstractTask`	getExtensions, getTimeout, setDescription, getProject, getIdentityPath, setGroup, getStandardOutputCapture, getAnt, getConvention, getLogging, getLogging, getDidWork, getAsDynamicObject, setActions, getTaskDependencies, getTaskDependencies, getDependsOn, setDependsOn, dependsOn, onlyIf, onlyIf, setOnlyIf, setOnlyIf, setDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, getEnabled, getOutputs, getOutputs, getDestroyables, getLocalState, getTemporaryDir, mustRunAfter, setMustRunAfter, getMustRunAfter, finalizedBy, setFinalizedBy, getFinalizedBy, shouldRunAfter, setShouldRunAfter, getShouldRunAfter, getTaskIdentity, injectIntoNewInstance, getTaskActions, hasTaskActions, getOnlyIf, getImpliesSubProjects, setImpliesSubProjects, replaceLogger, getTemporaryDirFactory, prependParallelSafeAction, appendParallelSafeAction, isHasCustomActions, getDescription, isEnabled, configure, configure, setEnabled, property, hasProperty, getGroup, getInputs, getInputs, toString, compareTo, compareTo, getName, setProperty, getLogger, getActions, getState, getState, getPath, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll

- Property Detail
  - @Input @Optional final Property<String> apiVersion
    
    The Docker remote API version.
  - @InputDirectory @PathSensitive(PathSensitivity.RELATIVE) @Optional final DirectoryProperty certPath
    
    Path to the Docker certificate and key.
  - @Input @Optional final Property<String> url
    
    Docker remote API server URL. Defaults to "http://localhost:2375".
- Method Detail
  - @Internal @Memoized com.github.dockerjava.api.DockerClient getDockerClient()
    
    Gets the Docker client uses to communicate with Docker via its remote API. Initialized instance upon first request. Returns the same instance for any successive method call.
    Before accessing the Docker client, all data used for configuring its runtime behavior needs to be evaluated. The data includes:
    1. The property values of this class
    2. The plugin's extension property values
    It is safe to access the Docker client under the following conditions:
    1. In the task action
    2. In the task's constructor if used in Action or Closure of outputs.upToDateWhen
    Returns:
    The Docker client
  - @Internal protected Action getNextHandler()
  - @Internal @Memoized protected RegistryAuthLocator getRegistryAuthLocator()
    
    Returns the instance of RegistryAuthLocator.
    Unless other credentials information provided, the instance returns authConfig object provided by the Docker client.
    Returns:
    The registry authentication locator
  - void onComplete(Runnable callback)
    
    Reacts to the completion of the operation.
    Parameters:
    callback - The callback to be executed
    Since:
    4.0.0
  - void onError(Action<? super Throwable> action)
    
    Reacts to a potential error occurring during the operation.
    Parameters:
    action - The action handling the error
    Since:
    4.0.0
  - void onNext(Action action)
    
    Reacts to data returned by an operation.
    Parameters:
    action - The action handling the data
    Since:
    4.0.0
  - void runRemoteCommand()
  - @TaskAction void start()

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Class AbstractDockerRemoteApiTask

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

@Input @Optional final Property<String> apiVersion

@InputDirectory @PathSensitive(PathSensitivity.RELATIVE) @Optional final DirectoryProperty certPath

@Input @Optional final Property<String> url

Method Detail

@Internal @Memoized com.github.dockerjava.api.DockerClient getDockerClient()

@Internal protected Action getNextHandler()

@Internal @Memoized protected RegistryAuthLocator getRegistryAuthLocator()

void onComplete(Runnable callback)

void onError(Action<? super Throwable> action)

void onNext(Action action)

void runRemoteCommand()

@TaskAction void start()