Package io.github.gmazzo.docker.compose

Interface DockerSettings

  • All Implemented Interfaces:
    org.gradle.api.credentials.Credentials 
    
public interface DockerSettings
 implements Credentials

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public interface DockerSettings.Login

    • 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
      Unit login(Action<DockerSettings.Login> action)
      abstract Property<String> getCommand() The docker command path.
      abstract ListProperty<String> getOptions() Optional options that corresponds to Global Options of the docker commandThis setting is shared between all org.gradle.api.Projects of the build
      abstract DockerSettings.Login getLogin() Optional login information to perform docker login command before any DockerComposeService is createdThis setting is shared between all org.gradle.api.Projects of the build

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • getCommand

         abstract Property<String> getCommand()

        The docker command path.

        It should not be changed unless you want to provide a full path for it.

        This setting is shared between all org.gradle.api.Projects of the build

      • getOptions

         abstract ListProperty<String> getOptions()

        Optional options that corresponds to Global Options of the docker command

        This setting is shared between all org.gradle.api.Projects of the build