final case class ClientConfig(globalReuse: DockerReusePolicy = ClientConfig.defaultReusePolicy, useRemote: Boolean = false, useGlobalRegistry: Boolean = false, remote: Option[RemoteDockerConfig] = None, globalRegistry: Option[String] = None, registryConfigs: List[DockerRegistryConfig] = List.empty) extends Product with Serializable

Client configuration that will be read from HOCON config. See docker-reference.conf for an example configuration. You can include the reference configuration if you want to use defaults.

globalReuse

If true and container's ContainerConfig#reuse is also true, keeps container alive after initialization. If false, the container will be shut down.

useRemote

Connect to Remote Docker Daemon

useGlobalRegistry

Use specified global Docker Registry.

remote

Options to connect to a Remote or Custom Docker Daemon (e.g. custom unix socket or pipe), will try to connect to using these options only if useRemote is true

globalRegistry

Registry for global usage if not overriden in ContainerConfig and if useGlobalRegistry is true.

registryConfigs

Registry credentials to connect to custom Docker Registry host.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClientConfig
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ClientConfig(globalReuse: DockerReusePolicy = ClientConfig.defaultReusePolicy, useRemote: Boolean = false, useGlobalRegistry: Boolean = false, remote: Option[RemoteDockerConfig] = None, globalRegistry: Option[String] = None, registryConfigs: List[DockerRegistryConfig] = List.empty)

    globalReuse

    If true and container's ContainerConfig#reuse is also true, keeps container alive after initialization. If false, the container will be shut down.

    useRemote

    Connect to Remote Docker Daemon

    useGlobalRegistry

    Use specified global Docker Registry.

    remote

    Options to connect to a Remote or Custom Docker Daemon (e.g. custom unix socket or pipe), will try to connect to using these options only if useRemote is true

    globalRegistry

    Registry for global usage if not overriden in ContainerConfig and if useGlobalRegistry is true.

    registryConfigs

    Registry credentials to connect to custom Docker Registry host.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  9. val globalRegistry: Option[String]
  10. val globalReuse: DockerReusePolicy
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. def productElementNames: Iterator[String]
    Definition Classes
    Product
  16. val registryConfigMap: Map[String, DockerRegistryConfig]
  17. val registryConfigs: List[DockerRegistryConfig]
  18. val remote: Option[RemoteDockerConfig]
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. val useGlobalRegistry: Boolean
  21. val useRemote: Boolean
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped