com.spotify.docker.client

Class DockerClient.BuildParam

java.lang.Object

com.spotify.docker.client.DockerClient.BuildParam

Enclosing interface:

DockerClient

public static class DockerClient.BuildParam
extends Object

Flags which can be passed to the build method.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static DockerClient.BuildParam	FORCE_RM Always remove intermediate containers.
private String	name
(package private) static DockerClient.BuildParam	NO_CACHE Do not use the cache when building the image.
(package private) static DockerClient.BuildParam	NO_RM Do not remove intermediate containers after a successful build.
(package private) static DockerClient.BuildParam	PULL_NEWER_IMAGE Always attempt to pull a newer version of the base image even if one exists locally.
(package private) static DockerClient.BuildParam	QUIET Suppress verbose build output.
(package private) static DockerClient.BuildParam	RM Do remove intermediate containers after a successful build.
private String	value

Constructor Summary

Constructors

Constructor and Description
BuildParam(String name, String value)

Method Summary

Modifier and Type	Method and Description
static DockerClient.BuildParam	create(String name, String value) Create a custom parameter.
String	name() Parameter name.
String	value() Parameter value.

Methods inherited from class java.lang.Object

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

Field Detail

QUIET

static final DockerClient.BuildParam QUIET

Suppress verbose build output.

NO_CACHE

static final DockerClient.BuildParam NO_CACHE

Do not use the cache when building the image.

RM

static final DockerClient.BuildParam RM

Do remove intermediate containers after a successful build.

NO_RM

static final DockerClient.BuildParam NO_RM

Do not remove intermediate containers after a successful build.

FORCE_RM

static final DockerClient.BuildParam FORCE_RM

Always remove intermediate containers.

PULL_NEWER_IMAGE

static final DockerClient.BuildParam PULL_NEWER_IMAGE

Always attempt to pull a newer version of the base image even if one exists locally.

name

private final String name

value

private final String value

Constructor Detail

BuildParam

public BuildParam(String name,
                  String value)

Method Detail

name

public String name()

Parameter name.

Returns:

name of parameter

value

public String value()

Parameter value.

Returns:

value of parameter

create

public static DockerClient.BuildParam create(String name,
                                             String value)

Create a custom parameter.

Parameters:

name - custom name

value - custom value

Returns:

BuildParam