
public final class Docker

Field Summary

Fields
Modifier and Type	Field	Description
`private final Boolean`	`running`
`private final Boolean`	`up`
`private final Boolean`	`upToDate`
`private final Property<Long>`	`upCheck`
`private final Stack`	`stack`
`private final ContainerManager`	`containers`
`private final Runtime`	`runtime`
`private final DockerRegistry`	`registry`
`private final RegularFileProperty`	`composeFile`
`private final RegularFileProperty`	`composeTemplateFile`
`private final MapProperty<String, Any>`	`composeProperties`
`private final EnvironmentExtension`	`environment`

Constructor Summary

Constructors
Constructor	Description
`Docker(EnvironmentExtension environment)`

Method Summary

Modifier and Type	Method	Description
`final Unit`	`stack(Function1<Stack, Unit> options)`	Configures Docker stack
`final Unit`	`containers(Function1<ContainerManager, Unit> options)`	Configure additional behavior for Docker containers defined in 'docker-compose.yml'.
`final Unit`	`registry(Function1<DockerRegistry, Unit> options)`	Configure registry-related options.
`final Unit`	`init()`
`final Unit`	`resolve()`
`final Unit`	`checkUp()`
`final Unit`	`up()`
`final Unit`	`reload()`
`final Unit`	`down()`
`final DockerResult`	`run(Function1<DockerRunSpec, Unit> spec)`
`final DockerResult`	`run(String image, List<String> args, Integer exitCode)`
`final DockerResult`	`run(String operation, String image, List<String> args, Integer exitCode)`
`final DockerResult`	`runShell(String image, String command, Integer exitCode)`
`final DockerResult`	`runShell(String operation, String image, String command, Integer exitCode)`
`final Unit`	`pull(String image)`
`final Unit`	`daemon(Function1<DockerDaemonSpec, Unit> spec)`
`final String`	`load(File file)`
`final Unit`	`load(String composePropertyName, Function0<File> fileProvider)`
`final Unit`	`load(String composePropertyName, Provider<File> fileProvider)`
`final Boolean`	`getRunning()`
`final Boolean`	`getUp()`
`final Boolean`	`getUpToDate()`
`final Property<Long>`	`getUpCheck()`	How long wait to wait until checking if environment remains up.
`final Stack`	`getStack()`	Represents Docker stack and provides API for manipulating it.
`final ContainerManager`	`getContainers()`	Provides API for manipulating Docker containers defined in 'docker-compose.yml'.
`final Runtime`	`getRuntime()`	Represents Docker runtime specific options.
`final DockerRegistry`	`getRegistry()`	Holds registry-related configuration options.
`final RegularFileProperty`	`getComposeFile()`
`final RegularFileProperty`	`getComposeTemplateFile()`
`final MapProperty<String, Any>`	`getComposeProperties()`
`final EnvironmentExtension`	`getEnvironment()`

Methods inherited from class com.cognifide.gradle.environment.docker.Docker
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Docker

Docker(EnvironmentExtension environment)

Method Detail

stack

 final Unit stack(Function1<Stack, Unit> options)

Configures Docker stack

containers
```
 final Unit containers(Function1<ContainerManager, Unit> options)
```
Configure additional behavior for Docker containers defined in 'docker-compose.yml'.

registry

 final Unit registry(Function1<DockerRegistry, Unit> options)

Configure registry-related options.

init
```
 final Unit init()
```

resolve
```
 final Unit resolve()
```

checkUp
```
 final Unit checkUp()
```

up
```
 final Unit up()
```

reload
```
 final Unit reload()
```

down
```
 final Unit down()
```

run

 final DockerResult run(Function1<DockerRunSpec, Unit> spec)

run

 final DockerResult run(String image, List<String> args, Integer exitCode)

run

 final DockerResult run(String operation, String image, List<String> args, Integer exitCode)

runShell

 final DockerResult runShell(String image, String command, Integer exitCode)

runShell

 final DockerResult runShell(String operation, String image, String command, Integer exitCode)

pull
```
 final Unit pull(String image)
```

daemon

 final Unit daemon(Function1<DockerDaemonSpec, Unit> spec)

load
```
 final String load(File file)
```

load

 final Unit load(String composePropertyName, Function0<File> fileProvider)

load

 final Unit load(String composePropertyName, Provider<File> fileProvider)

getRunning
```
 final Boolean getRunning()
```

getUp
```
 final Boolean getUp()
```

getUpToDate
```
 final Boolean getUpToDate()
```

getUpCheck
```
 final Property<Long> getUpCheck()
```
How long wait to wait until checking if environment remains up.

getStack
```
 final Stack getStack()
```
Represents Docker stack and provides API for manipulating it.

getContainers
```
 final ContainerManager getContainers()
```
Provides API for manipulating Docker containers defined in 'docker-compose.yml'.

getRuntime
```
 final Runtime getRuntime()
```
Represents Docker runtime specific options.

getRegistry
```
 final DockerRegistry getRegistry()
```
Holds registry-related configuration options.

getComposeFile

 final RegularFileProperty getComposeFile()

getComposeTemplateFile

 final RegularFileProperty getComposeTemplateFile()

getComposeProperties

 final MapProperty<String, Any> getComposeProperties()

getEnvironment

 final EnvironmentExtension getEnvironment()

Class Docker

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

Docker

Method Detail

stack

containers

registry

init

resolve

checkUp

up

reload

down

run

run

run

runShell

runShell

pull

daemon

load

load

load

getRunning

getUp

getUpToDate

getUpCheck

getStack

getContainers

getRuntime

getRegistry

getComposeFile

getComposeTemplateFile

getComposeProperties

getEnvironment