Package io.github.gmazzo.docker.compose
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
-
-
Field Summary
Fields Modifier and Type Field Description private final Property<String>projectNameprivate final ConfigurableFileCollectioncomposeFileprivate final DirectoryPropertyworkingDirectoryprivate final ListProperty<String>optionsCreateprivate final Property<Boolean>startprivate final TaskOutputsInternaloutputsprivate final Spec<in TaskInternal>onlyIfprivate final Property<Duration>timeoutprivate final TaskRequiredServicesrequiredServicesprivate final TaskDependencyInternaltaskDependenciesprivate final Set<Object>dependsOnprivate final TaskDestroyablesdestroyablesprivate final Loggerloggerprivate final Stringpathprivate final Factory<File>temporaryDirFactoryprivate final Optional<String>reasonTaskIsIncompatibleWithConfigurationCacheprivate final TaskLocalStatelocalStateprivate final List<InputChangesAwareTaskAction>taskActionsprivate final TaskDependencyInternallifecycleDependenciesprivate BooleanisEnabledprivate BooleanimpliesSubProjectsprivate final TaskInputsInternalinputsprivate Booleanenabledprivate final TaskStateInternalstateprivate final TaskIdentity<?>taskIdentityprivate final TaskDependencyshouldRunAfterprivate final ExtensionContainerextensionsprivate final BooleanisCompatibleWithConfigurationCacheprivate final TaskDependencyfinalizedByprivate final AntBuilderantprivate final DynamicObjectasDynamicObjectprivate final List<ResourceLock>sharedResourcesprivate BooleandidWorkprivate final Optional<String>reasonNotToTrackStateprivate Stringgroupprivate final Set<String>reasonsNotToTrackStateprivate final BooleanisHasCustomActionsprivate List<Action<in Task>>actionsprivate final Stringnameprivate final FiletemporaryDirprivate final LoggingManagerloggingprivate final PathidentityPathprivate final TaskDependencymustRunAfterprivate final StandardOutputCapturestandardOutputCaptureprivate final Projectprojectprivate Stringdescription
-
Constructor Summary
Constructors Constructor Description DockerComposeInitTask()
-
Method Summary
Modifier and Type Method Description abstract Property<String>getProjectName()The name of the Docker compose project used to generate container names. abstract ConfigurableFileCollectiongetComposeFile()The source locations for the docker-composefile.abstract DirectoryPropertygetWorkingDirectory()The working directory for the docker-composecommand.abstract ListProperty<String>getOptionsCreate()Optional options to append to the docker compose createcommandDefaults to--remove-orphansto ensure only containers defined in the docker file are keptabstract Property<Boolean>getStart()final UnitinitContainers()-
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
-
-
Method Detail
-
getProjectName
@Input() abstract Property<String> getProjectName()
The name of the Docker compose project used to generate container names.
Maps to
--project-nameargument
-
getComposeFile
@InputFiles()@PathSensitive(value = PathSensitivity.RELATIVE) abstract ConfigurableFileCollection getComposeFile()
The source locations for the
docker-composefile.
-
getWorkingDirectory
@Internal() abstract DirectoryProperty getWorkingDirectory()
The working directory for the
docker-composecommand.Defaults to the project's directory.
-
getOptionsCreate
@Input() abstract ListProperty<String> getOptionsCreate()
Optional options to append to the
docker compose createcommandDefaults to
--remove-orphansto ensure only containers defined in the docker file are kept
-
initContainers
final Unit initContainers()
-
-
-
-