
public class DockerRunSpec
 extends DockerInvokeSpec

DSL for running command 'docker run'.

Field Summary

Fields
Modifier and Type	Field	Description
`private final Property<String>`	`name`
`private final Property<String>`	`image`
`private final MapProperty<String, String>`	`volumes`
`private final MapProperty<String, String>`	`ports`
`private final Property<Boolean>`	`autoRemove`
`private final Property<Boolean>`	`detached`
`private final ListProperty<String>`	`options`
`private final ListProperty<String>`	`args`
`private final Provider<String>`	`command`
`private final Property<String>`	`operation`
`private final Property<Boolean>`	`indicator`
`private final DirectoryProperty`	`commandDir`
`private final ListProperty<String>`	`commandLine`
`private ListProperty<Int>`	`exitCodes`
`private Property<InputStream>`	`input`
`private final Property<OutputStream>`	`output`
`private final Property<OutputStream>`	`errors`

Constructor Summary

Constructors
Constructor	Description
`DockerRunSpec(Docker docker)`

Method Summary

Modifier and Type	Method	Description
`final Unit`	`port(Integer hostPort, Integer containerPort)`
`final Unit`	`port(String hostPort, String containerPort)`
`final Unit`	`port(Integer port)`
`final Unit`	`volume(String containerPath)`
`final Unit`	`volume(File localFile, String containerPath)`
`final Unit`	`volume(String localPath, String containerPath)`
`final Unit`	`workDirVolume(String containerPath)`
`final Property<String>`	`getName()`
`final Property<String>`	`getImage()`
`final MapProperty<String, String>`	`getVolumes()`
`final MapProperty<String, String>`	`getPorts()`
`final Property<Boolean>`	`getAutoRemove()`
`final Property<Boolean>`	`getDetached()`
`final ListProperty<String>`	`getOptions()`
`final ListProperty<String>`	`getArgs()`
`final Provider<String>`	`getCommand()`
`final Property<String>`	`getOperation()`
`final Property<Boolean>`	`getIndicator()`
`final DirectoryProperty`	`getCommandDir()`
`final ListProperty<String>`	`getCommandLine()`
`final ListProperty<Int>`	`getExitCodes()`
`final Property<InputStream>`	`getInput()`
`final Property<OutputStream>`	`getOutput()`
`final Property<OutputStream>`	`getErrors()`
`final Unit`	`setExitCodes(ListProperty<Int> exitCodes)`
`final Unit`	`setInput(Property<InputStream> input)`

Methods inherited from class com.cognifide.gradle.environment.docker.DockerRunSpec
args, args, argsShell, env, env, envFile, envFile, options, options, workDir
Methods inherited from class com.cognifide.gradle.environment.docker.DockerInvokeSpec
exitCode, ignoreExitCodes, nullOut, systemOut
Methods inherited from class com.cognifide.gradle.environment.docker.DockerSpec
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- DockerRunSpec
```
DockerRunSpec(Docker docker)
```

Method Detail

port

 final Unit port(Integer hostPort, Integer containerPort)

port

 final Unit port(String hostPort, String containerPort)

port
```
 final Unit port(Integer port)
```

volume

 final Unit volume(String containerPath)

volume

 final Unit volume(File localFile, String containerPath)

volume

 final Unit volume(String localPath, String containerPath)

workDirVolume

 final Unit workDirVolume(String containerPath)

getName
```
 final Property<String> getName()
```

getImage
```
 final Property<String> getImage()
```

getVolumes

 final MapProperty<String, String> getVolumes()

getPorts

 final MapProperty<String, String> getPorts()

getAutoRemove

 final Property<Boolean> getAutoRemove()

getDetached
```
 final Property<Boolean> getDetached()
```

getOptions

 final ListProperty<String> getOptions()

getArgs
```
 final ListProperty<String> getArgs()
```

getCommand
```
 final Provider<String> getCommand()
```

getOperation
```
 final Property<String> getOperation()
```

getIndicator
```
 final Property<Boolean> getIndicator()
```

getCommandDir

 final DirectoryProperty getCommandDir()

getCommandLine

 final ListProperty<String> getCommandLine()

getExitCodes
```
 final ListProperty<Int> getExitCodes()
```

getInput
```
 final Property<InputStream> getInput()
```

getOutput

 final Property<OutputStream> getOutput()

getErrors

 final Property<OutputStream> getErrors()

setExitCodes

 final Unit setExitCodes(ListProperty<Int> exitCodes)

setInput

 final Unit setInput(Property<InputStream> input)

Class DockerRunSpec

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.cognifide.gradle.environment.docker.DockerRunSpec

Methods inherited from class com.cognifide.gradle.environment.docker.DockerInvokeSpec

Methods inherited from class com.cognifide.gradle.environment.docker.DockerSpec

Methods inherited from class java.lang.Object

Constructor Detail

DockerRunSpec

Method Detail

port

port

port

volume

volume

volume

workDirVolume

getName

getImage

getVolumes

getPorts

getAutoRemove

getDetached

getOptions

getArgs

getCommand

getOperation

getIndicator

getCommandDir

getCommandLine

getExitCodes

getInput

getOutput

getErrors

setExitCodes

setInput