com.spotify.docker.client

Class DockerClient.RemoveContainerParam

java.lang.Object

com.spotify.docker.client.DockerClient.Param

com.spotify.docker.client.DockerClient.RemoveContainerParam

Enclosing interface:

DockerClient

public static class DockerClient.RemoveContainerParam
extends DockerClient.Param

Parameters for DockerClient.removeContainer(String).

Constructor Summary

Constructors

Constructor and Description
RemoveContainerParam(String name, String value)

Method Summary

Modifier and Type	Method and Description
static DockerClient.RemoveContainerParam	create(String name, String value) Create a custom parameter.
static DockerClient.RemoveContainerParam	forceKill() Kill then remove the container.
static DockerClient.RemoveContainerParam	forceKill(boolean force) Kill then remove the container.
static DockerClient.RemoveContainerParam	removeVolumes() Remove the volumes associated to the container.
static DockerClient.RemoveContainerParam	removeVolumes(boolean remove) Remove the volumes associated to the container.

Methods inherited from class com.spotify.docker.client.DockerClient.Param

equals, hashCode, name, value

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoveContainerParam

public RemoveContainerParam(String name,
                            String value)

Method Detail

create

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

Create a custom parameter.

Parameters:

name - custom name

value - custom value

Returns:

BuildParam

removeVolumes

public static DockerClient.RemoveContainerParam removeVolumes()

Remove the volumes associated to the container. If not specified, defaults to false.

Returns:

RemoveContainerParam

removeVolumes

public static DockerClient.RemoveContainerParam removeVolumes(boolean remove)

Remove the volumes associated to the container. If not specified, defaults to false.

Parameters:

remove - Whether to remove volumes

Returns:

RemoveContainerParam

forceKill

public static DockerClient.RemoveContainerParam forceKill()

Kill then remove the container. If not specified, defaults to false.

Returns:

RemoveContainerParam

forceKill

public static DockerClient.RemoveContainerParam forceKill(boolean force)

Kill then remove the container. If not specified, defaults to false.

Parameters:

force - Whether to force kill before removing.

Returns:

RemoveContainerParam