Package io.github.pgatzka.docker.task.volume

Class CreateVolumeTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
io.github.pgatzka.docker.task.DockerTask
io.github.pgatzka.docker.task.volume.CreateVolumeTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
@UntrackedTask(because="Docker daemon side effects must always run") public abstract class CreateVolumeTask extends DockerTask
Creates a Docker named volume according to its VolumeSpec.

Idempotent: a no-op when a volume with the same name already exists (driver and options are not reconciled). Marked UntrackedTask because the daemon side effect must always run.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Named

    org.gradle.api.Named.Namer

  • Field Summary

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

  • Constructor Summary

    Constructors
    Constructor
    Description
    CreateVolumeTask()
    Invoked by Gradle's bytecode-decorated subclass; not for direct use.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    execute()
    Gradle entry point for this task.
    abstract org.gradle.api.provider.Property<String>
    getDriver()
    Mirrors VolumeSpec.driver: the volume driver (e.g.
    abstract org.gradle.api.provider.MapProperty<String,String>
    getDriverOpts()
    Mirrors VolumeSpec.driverOpts: driver-specific options forwarded to the daemon.
    abstract org.gradle.api.provider.MapProperty<String,String>
    getLabels()
    Mirrors VolumeSpec.labels: labels applied to the volume on the daemon.
    abstract org.gradle.api.provider.Property<String>
    getVolumeName()
    Mirrors VolumeSpec.name: the volume name registered on the daemon.

    Methods inherited from class io.github.pgatzka.docker.task.DockerTask

    getDockerService

    Methods inherited from class org.gradle.api.DefaultTask

    compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

    Methods inherited from class org.gradle.api.internal.AbstractTask

    acceptServiceReferences, appendParallelSafeAction, doNotTrackState, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, setImpliesSubProjects

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Constructor Details

    • CreateVolumeTask

      public CreateVolumeTask()
      Invoked by Gradle's bytecode-decorated subclass; not for direct use.

  • Method Details

    • getVolumeName

      @Input public abstract org.gradle.api.provider.Property<String> getVolumeName()
      Mirrors VolumeSpec.name: the volume name registered on the daemon.
      Returns:
      the volume name property

    • getDriver

      @Input public abstract org.gradle.api.provider.Property<String> getDriver()
      Mirrors VolumeSpec.driver: the volume driver (e.g. local).
      Returns:
      the volume driver property

    • getDriverOpts

      @Input public abstract org.gradle.api.provider.MapProperty<String,String> getDriverOpts()
      Mirrors VolumeSpec.driverOpts: driver-specific options forwarded to the daemon.
      Returns:
      the driver options property

    • getLabels

      @Input public abstract org.gradle.api.provider.MapProperty<String,String> getLabels()
      Mirrors VolumeSpec.labels: labels applied to the volume on the daemon.
      Returns:
      the labels property

    • execute

      public void execute()
      Gradle entry point for this task. Delegates to the package-private run(DockerClient, String, String, Map, Map, Logger) helper.