Class DockerComposeInitTask

  • All Implemented Interfaces:
    io.github.gmazzo.docker.compose.DockerComposeCreateSettings , kotlin.Comparable , org.gradle.api.Named , org.gradle.api.Task , org.gradle.api.internal.DynamicObjectAware , org.gradle.api.internal.TaskInternal , org.gradle.api.plugins.ExtensionAware , org.gradle.util.Configurable

    @DisableCachingByDefault() 
    public abstract class DockerComposeInitTask
    extends DefaultTask implements DockerComposeCreateSettings
                        
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract Property<String> getProjectName() The name of the Docker compose project used to generate container names.
      abstract ConfigurableFileCollection getComposeFile() The source locations for the docker-compose file.
      abstract DirectoryProperty getWorkingDirectory() The working directory for the docker-compose command.
      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
      abstract Property<Boolean> getStart()
      final Unit initContainers()
      • Methods inherited from class org.gradle.api.DefaultTask

        getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, setActions, setDescription, setDidWork, setEnabled, setEnabled, setGroup
      • Methods inherited from class org.gradle.api.internal.AbstractTask

        getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getReasonsNotToTrackState, getRequiredServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, setImpliesSubProjects
      • Methods inherited from class io.github.gmazzo.docker.compose.DockerComposeCreateSettings

        composeFile
      • Methods inherited from class org.gradle.api.Task

        configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, doNotTrackState, finalizedBy, hasProperty, mustRunAfter, notCompatibleWithConfigurationCache, onlyIf, onlyIf, onlyIf, property, setDependsOn, setFinalizedBy, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService
      • Methods inherited from class kotlin.Comparable

        compareTo
      • Methods inherited from class org.gradle.api.internal.TaskInternal

        acceptServiceReferences, appendParallelSafeAction, doNotTrackStateIf, hasTaskActions, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DockerComposeInitTask

        DockerComposeInitTask()
    • Method Detail

      • getProjectName

        @Input() abstract Property<String> getProjectName()

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

        Maps to --project-name argument

      • getComposeFile

        @InputFiles()@PathSensitive(value = PathSensitivity.RELATIVE) abstract ConfigurableFileCollection getComposeFile()

        The source locations for the docker-compose file.

      • getWorkingDirectory

        @Internal() abstract DirectoryProperty getWorkingDirectory()

        The working directory for the docker-compose command.

        Defaults to the project's directory.

      • getOptionsCreate

        @Input() 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