Packages

final case class ClientConfig(readTimeoutMs: Int = 60000, connectTimeoutMs: Int = 1000, allowReuse: Boolean = true, useRemote: Boolean = false, useRegistry: Boolean = false, remote: Option[RemoteDockerConfig] = None, registry: Option[DockerRegistryConfig] = None) 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.

readTimeoutMs

Read timeout in milliseconds

connectTimeoutMs

Connect timeout in milliseconds

allowReuse

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

useRegistry

Connect to speicifed Docker Registry

remote

Options to connect to a Remote Docker Daemon, will try to connect to remote docker if useRemote is true

registry

Options to connect to custom Docker Registry host, will try to connect to specified registry, instead of the default if useRegistry is true

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(readTimeoutMs: Int = 60000, connectTimeoutMs: Int = 1000, allowReuse: Boolean = true, useRemote: Boolean = false, useRegistry: Boolean = false, remote: Option[RemoteDockerConfig] = None, registry: Option[DockerRegistryConfig] = None)

    readTimeoutMs

    Read timeout in milliseconds

    connectTimeoutMs

    Connect timeout in milliseconds

    allowReuse

    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

    useRegistry

    Connect to speicifed Docker Registry

    remote

    Options to connect to a Remote Docker Daemon, will try to connect to remote docker if useRemote is true

    registry

    Options to connect to custom Docker Registry host, will try to connect to specified registry, instead of the default if useRegistry is true

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. val allowReuse: Boolean
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. val connectTimeoutMs: Int
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  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 readTimeoutMs: Int
  17. val registry: Option[DockerRegistryConfig]
  18. val remote: Option[RemoteDockerConfig]
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. val useRegistry: 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