Package io.github.pgatzka.docker.dsl.spec

Class VolumeSpec

java.lang.Object
io.github.pgatzka.docker.dsl.spec.VolumeSpec
All Implemented Interfaces:
org.gradle.api.Named
public abstract class VolumeSpec extends Object implements org.gradle.api.Named
Spec describing a Docker named volume the plugin will create and manage. Instantiated by Gradle's ObjectFactory for each name registered in docker { volumes { register(...) }}.

  • Nested Class Summary

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

    org.gradle.api.Named.Namer

  • Constructor Summary

    Constructors
    Constructor
    Description
    VolumeSpec(String name)
    Invoked by Gradle's ObjectFactory when a volume is registered.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.provider.Property<String>
    getDriver()
    Volume driver passed to docker volume create --driver.
    abstract org.gradle.api.provider.MapProperty<String,String>
    getDriverOpts()
    Driver-specific options forwarded as --opt KEY=VALUE pairs.
    abstract org.gradle.api.provider.MapProperty<String,String>
    getLabels()
    Labels applied to the volume as --label KEY=VALUE pairs.
    String
    getName()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • VolumeSpec

      @Inject public VolumeSpec(String name)
      Invoked by Gradle's ObjectFactory when a volume is registered. Defaults driver to "local".
      Parameters:
      name - logical volume name as registered in the DSL

  • Method Details

    • getDriver

      public abstract org.gradle.api.provider.Property<String> getDriver()
      Volume driver passed to docker volume create --driver. Defaults to "local".
      Returns:
      the driver property

    • getDriverOpts

      public abstract org.gradle.api.provider.MapProperty<String,String> getDriverOpts()
      Driver-specific options forwarded as --opt KEY=VALUE pairs.
      Returns:
      the driver-opts property

    • getLabels

      public abstract org.gradle.api.provider.MapProperty<String,String> getLabels()
      Labels applied to the volume as --label KEY=VALUE pairs.
      Returns:
      the labels property

    • getName

      public String getName()
      Specified by:
      getName in interface org.gradle.api.Named