Package io.github.gmazzo.docker.compose
Interface DockerComposeSettings
-
- All Implemented Interfaces:
-
io.github.gmazzo.docker.compose.DockerComposeCreateSettings
public interface DockerComposeSettings implements DockerComposeCreateSettings
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceDockerComposeSettings.WaitForTCPPorts
-
Method Summary
Modifier and Type Method Description UnitwaitForTCPPorts(Action<DockerComposeSettings.WaitForTCPPorts> action)abstract ListProperty<String>getOptionsUp()Optional options to append to the docker compose upcommand.abstract ListProperty<String>getOptionsDown()Optional options to append to the docker compose downcommandabstract Property<Boolean>getKeepContainersRunning()If containers should not be automatically shutdown after the build is finished or not abstract Property<Boolean>getPrintPortMappings()If ports mapping table should be printed to the Gradle standard output when containers are started or not abstract Property<Boolean>getPrintLogs()If logs from the running containers should be printed to the Gradle standard output or not abstract DockerComposeSettings.WaitForTCPPortsgetWaitForTCPPorts()Allows configuring the waiting for TCP ports -
Methods inherited from class io.github.gmazzo.docker.compose.DockerComposeCreateSettings
composeFile, getComposeFile, getOptionsCreate, getProjectName, getWorkingDirectory -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
waitForTCPPorts
Unit waitForTCPPorts(Action<DockerComposeSettings.WaitForTCPPorts> action)
-
getOptionsUp
abstract ListProperty<String> getOptionsUp()
Optional options to append to the
docker compose upcommand.For consistency, optionsCreate will be propagated to optionsUp.
Defaults to
--waitto assure containers are healthy before moving forward with the build
-
getOptionsDown
abstract ListProperty<String> getOptionsDown()
Optional options to append to the
docker compose downcommand
-
getKeepContainersRunning
abstract Property<Boolean> getKeepContainersRunning()
If containers should not be automatically shutdown after the build is finished or not
-
getPrintPortMappings
abstract Property<Boolean> getPrintPortMappings()
If ports mapping table should be printed to the Gradle standard output when containers are started or not
-
getPrintLogs
abstract Property<Boolean> getPrintLogs()
If logs from the running containers should be printed to the Gradle standard output or not
-
getWaitForTCPPorts
abstract DockerComposeSettings.WaitForTCPPorts getWaitForTCPPorts()
Allows configuring the waiting for TCP ports
-
-
-
-