Package io.github.gmazzo.docker.compose

Interface DockerComposeCreateSettings

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      ConfigurableFileCollection composeFile(Object paths) Adds a source location for the docker-compose file.
      abstract Property<String> getProjectName() The name of the Docker compose project used to generate container names.
      abstract DirectoryProperty getWorkingDirectory() The working directory for the docker-compose command.
      abstract ConfigurableFileCollection getComposeFile() The source locations for the docker-compose file.
      abstract ListProperty<String> getOptionsCreate() Optional options to append to the docker compose create commandDefaults to --remove-orphans to ensure only containers defined in the docker file are kept

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • composeFile

         ConfigurableFileCollection composeFile(Object paths)

        Adds a source location for the docker-compose file.

      • getProjectName

         abstract Property<String> getProjectName()

        The name of the Docker compose project used to generate container names.

        Maps to --project-name argument

      • getWorkingDirectory

         abstract DirectoryProperty getWorkingDirectory()

        The working directory for the docker-compose command.

        Defaults to the project's directory.

      • getComposeFile

         abstract ConfigurableFileCollection getComposeFile()

        The source locations for the docker-compose file.

      • getOptionsCreate

         abstract ListProperty<String> getOptionsCreate()

        Optional options to append to the docker compose create command

        Defaults to --remove-orphans to ensure only containers defined in the docker file are kept