DockerCopyFileFromContainer (gradle-docker-plugin 6.7.0 API)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

com.bmuschko.gradle.docker.tasks.container.DockerCopyFileFromContainer

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`

Properties Summary

Properties
Type	Name and description
`Property<Boolean>`	`compressed` Whether to leave file in its compressed state or not.
`Property<String>`	`hostPath` Path on host to write remotePath to or into.
`Property<String>`	`remotePath` Path inside container

Constructor Summary

Constructors
Constructor and description
`DockerCopyFileFromContainer ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`runRemoteCommand()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DockerExistingContainer`	`targetContainerId, targetContainerId, targetContainerId`
`class AbstractDockerRemoteApiTask`	`getDockerClient, getNextHandler, getRegistryAuthLocator, onComplete, onError, onNext, runRemoteCommand, start`
`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

- Property Detail
  - @Input @Optional final Property<Boolean> compressed
    
    Whether to leave file in its compressed state or not. Docker CP command hands back a tar stream regardless if we asked for a regular file or directory. Thus, we can give the caller back the tar file as-is or explode it to some destination like 'docker cp' does.
  - @Input final Property<String> hostPath
    
    Path on host to write remotePath to or into. If hostPath does not exist it will be created relative to what we need it to be (e.g. regular file or directory). This is consistent with how 'docker cp' behaves.
  - @Input final Property<String> remotePath
    
    Path inside container
- Constructor Detail
  - DockerCopyFileFromContainer()
- Method Detail
  - @Override void runRemoteCommand()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation