com.spotify.docker.client

Class DefaultDockerClient.Builder

java.lang.Object

com.spotify.docker.client.DefaultDockerClient.Builder

Enclosing class:

DefaultDockerClient

public static class DefaultDockerClient.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
private String	apiVersion
private AuthConfig	authConfig
private int	connectionPoolSize
private long	connectTimeoutMillis
private DockerCertificates	dockerCertificates
private long	readTimeoutMillis
private URI	uri

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
String	apiVersion()
DefaultDockerClient.Builder	apiVersion(String apiVersion) Set the Docker API version that will be used in the HTTP requests to Docker daemon.
AuthConfig	authConfig()
DefaultDockerClient.Builder	authConfig(AuthConfig authConfig) Set the auth parameters for pull/push requests from/to private repositories.
DefaultDockerClient	build()
int	connectionPoolSize()
DefaultDockerClient.Builder	connectionPoolSize(int connectionPoolSize) Set the size of the connection pool for connections to Docker.
long	connectTimeoutMillis()
DefaultDockerClient.Builder	connectTimeoutMillis(long connectTimeoutMillis) Set the timeout in milliseconds until a connection to Docker is established.
DockerCertificates	dockerCertificates()
DefaultDockerClient.Builder	dockerCertificates(DockerCertificates dockerCertificates) Provide certificates to secure the connection to Docker.
long	readTimeoutMillis()
DefaultDockerClient.Builder	readTimeoutMillis(long readTimeoutMillis) Set the SO_TIMEOUT in milliseconds.
URI	uri()
DefaultDockerClient.Builder	uri(String uri) Set the URI for connections to Docker.
DefaultDockerClient.Builder	uri(URI uri)

Methods inherited from class java.lang.Object

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

Field Detail

uri

private URI uri

apiVersion

private String apiVersion

connectTimeoutMillis

private long connectTimeoutMillis

readTimeoutMillis

private long readTimeoutMillis

connectionPoolSize

private int connectionPoolSize

dockerCertificates

private DockerCertificates dockerCertificates

authConfig

private AuthConfig authConfig

Constructor Detail

Builder

public Builder()

Method Detail

uri

public URI uri()

uri

public DefaultDockerClient.Builder uri(URI uri)

uri

public DefaultDockerClient.Builder uri(String 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 DockerCertificates dockerCertificates()

dockerCertificates

public DefaultDockerClient.Builder dockerCertificates(DockerCertificates dockerCertificates)

Provide certificates to secure the connection to Docker.

Parameters:

dockerCertificates - DockerCertificates 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

authConfig

public AuthConfig authConfig()

authConfig

public DefaultDockerClient.Builder authConfig(AuthConfig authConfig)

Set the auth parameters for pull/push requests from/to private repositories.

Parameters:

authConfig - AuthConfig object

Returns:

Builder

build

public DefaultDockerClient build()