DockerCopyFileFromContainer (gradle-docker-plugin 9.3.0 API)

java.lang.Object
- org.gradle.api.internal.AbstractTask
- - org.gradle.api.DefaultTask
  - - com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
    - - com.bmuschko.gradle.docker.tasks.container.DockerExistingContainer
      - com.bmuschko.gradle.docker.tasks.container.DockerCopyFileFromContainer

All Implemented Interfaces:

Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, Configurable<Task>
```
public class DockerCopyFileFromContainer
extends DockerExistingContainer
```

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
`DockerCopyFileFromContainer(ObjectFactory objects, ProjectLayout layout, FileSystemOperations fileSystemOperations, ArchiveOperations archiveOperations)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Property<Boolean>`	`getCompressed()`	Whether to leave file in its compressed state or not.
`Property<String>`	`getHostPath()`	Path on host to write remotePath to or into.
`Property<String>`	`getRemotePath()`	Path inside container
`void`	`runRemoteCommand()`

Methods inherited from class com.bmuschko.gradle.docker.tasks.container.DockerExistingContainer
getContainerId, targetContainerId, targetContainerId, targetContainerId

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 Detail
  - DockerCopyFileFromContainer
```
@Inject
public DockerCopyFileFromContainer(ObjectFactory objects,
                                   ProjectLayout layout,
                                   FileSystemOperations fileSystemOperations,
                                   ArchiveOperations archiveOperations)
```
- Method Detail
  - getRemotePath
```
@Input
public final Property<String> getRemotePath()
```
    Path inside container
  - getHostPath
```
@Input
public final Property<String> getHostPath()
```
    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.
  - getCompressed
```
@Input
@Optional
public final Property<Boolean> getCompressed()
```
    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.
  - runRemoteCommand
```
public void runRemoteCommand()
                      throws IOException
```
    Specified by:
    
    runRemoteCommand in class AbstractDockerRemoteApiTask
    
    Throws:
    
    IOException