Class DefaultDockerClient.Builder

java.lang.Object
com.spotify.docker.client.DefaultDockerClient.Builder
Enclosing class:
DefaultDockerClient

public static class DefaultDockerClient.Builder extends Object
  • Field Details

    • ERROR_MESSAGE

      public static final String ERROR_MESSAGE
      See Also:
    • uri

      private URI uri
    • apiVersion

      private String apiVersion
    • connectTimeoutMillis

      private long connectTimeoutMillis
    • readTimeoutMillis

      private long readTimeoutMillis
    • connectionPoolSize

      private int connectionPoolSize
    • dockerCertificatesStore

      private DockerCertificatesStore dockerCertificatesStore
    • dockerAuth

      private boolean dockerAuth
    • useProxy

      private boolean useProxy
    • registryAuth

      private RegistryAuth registryAuth
    • registryAuthSupplier

      private RegistryAuthSupplier registryAuthSupplier
    • headers

      private Map<String,Object> headers
    • requestEntityProcessing

      private org.glassfish.jersey.client.RequestEntityProcessing requestEntityProcessing
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • uri

      public URI uri()
    • uri

      public DefaultDockerClient.Builder uri(URI uri)
    • uri

      Set the URI for connections to Docker.
      Parameters:
      uri - URI String for connections to Docker
      Returns:
      Builder
    • apiVersion

      public DefaultDockerClient.Builder apiVersion(String apiVersion)
      Set the Docker API version that will be used in the HTTP requests to Docker daemon.
      Parameters:
      apiVersion - String for Docker API version
      Returns:
      Builder
    • apiVersion

      public String apiVersion()
    • connectTimeoutMillis

      public long connectTimeoutMillis()
    • connectTimeoutMillis

      public DefaultDockerClient.Builder connectTimeoutMillis(long connectTimeoutMillis)
      Set the timeout in milliseconds until a connection to Docker is established. A timeout value of zero is interpreted as an infinite timeout.
      Parameters:
      connectTimeoutMillis - connection timeout to Docker daemon in milliseconds
      Returns:
      Builder
    • readTimeoutMillis

      public long readTimeoutMillis()
    • readTimeoutMillis

      public DefaultDockerClient.Builder readTimeoutMillis(long readTimeoutMillis)
      Set the SO_TIMEOUT in milliseconds. This is the maximum period of inactivity between receiving two consecutive data packets from Docker.
      Parameters:
      readTimeoutMillis - read timeout to Docker daemon in milliseconds
      Returns:
      Builder
    • dockerCertificates

      public DockerCertificatesStore dockerCertificates()
    • dockerCertificates

      public DefaultDockerClient.Builder dockerCertificates(DockerCertificatesStore dockerCertificatesStore)
      Provide certificates to secure the connection to Docker.
      Parameters:
      dockerCertificatesStore - DockerCertificatesStore object
      Returns:
      Builder
    • connectionPoolSize

      public int connectionPoolSize()
    • connectionPoolSize

      public DefaultDockerClient.Builder connectionPoolSize(int connectionPoolSize)
      Set the size of the connection pool for connections to Docker. Note that due to a known issue, DefaultDockerClient maintains two separate connection pools, each of which is capped at this size. Therefore, the maximum number of concurrent connections to Docker may be up to 2 * connectionPoolSize.
      Parameters:
      connectionPoolSize - connection pool size
      Returns:
      Builder
    • dockerAuth

      public boolean dockerAuth()
    • dockerAuth

      @Deprecated public DefaultDockerClient.Builder dockerAuth(boolean dockerAuth)
      Allows reusing Docker auth info.
      Parameters:
      dockerAuth - tells if Docker auth info should be used
      Returns:
      Builder
    • useProxy

      public boolean useProxy()
    • useProxy

      public DefaultDockerClient.Builder useProxy(boolean useProxy)
      Allows connecting to Docker Daemon using HTTP proxy.
      Parameters:
      useProxy - tells if Docker Client has to connect to docker daemon using HTTP Proxy
      Returns:
      Builder
    • registryAuth

      public RegistryAuth registryAuth()
    • registryAuth

      @Deprecated public DefaultDockerClient.Builder registryAuth(RegistryAuth registryAuth)
      Set the auth parameters for pull/push requests from/to private repositories.
      Parameters:
      registryAuth - RegistryAuth object
      Returns:
      Builder
    • registryAuthSupplier

      public DefaultDockerClient.Builder registryAuthSupplier(RegistryAuthSupplier registryAuthSupplier)
    • header

      public DefaultDockerClient.Builder header(String name, Object value)
      Adds additional headers to be sent in all requests to the Docker Remote API.
    • headers

      public Map<String,Object> headers()
    • useRequestEntityProcessing

      public DefaultDockerClient.Builder useRequestEntityProcessing(org.glassfish.jersey.client.RequestEntityProcessing requestEntityProcessing)
      Allows setting transfer encoding. CHUNKED does not send the content-length header while BUFFERED does.

      By default ApacheConnectorProvider uses CHUNKED mode. Some Docker API end-points seems to fail when no content-length is specified but a body is sent.

      Parameters:
      requestEntityProcessing - is the requested entity processing to use when calling docker daemon (tcp protocol).
      Returns:
      Builder
    • getRequestEntityProcessing

      public org.glassfish.jersey.client.RequestEntityProcessing getRequestEntityProcessing()
    • build

      public DefaultDockerClient build()