Package org.mandas.docker.client
Class DockerClient.RemoveContainerParam
- java.lang.Object
-
- org.mandas.docker.client.DockerClient.Param
-
- org.mandas.docker.client.DockerClient.RemoveContainerParam
-
- Enclosing interface:
- DockerClient
public static class DockerClient.RemoveContainerParam extends DockerClient.Param
Parameters forDockerClient.removeContainer(String)
.
-
-
Constructor Summary
Constructors Constructor Description RemoveContainerParam(String name, String value)
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method 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 org.mandas.docker.client.DockerClient.Param
equals, hashCode, name, value
-
-
-
-
Method Detail
-
create
public static DockerClient.RemoveContainerParam create(String name, String value)
Create a custom parameter.- Parameters:
name
- custom namevalue
- 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
-
-