com.spotify.docker.client

Class DockerClient.ListContainersParam

java.lang.Object

com.spotify.docker.client.DockerClient.ListContainersParam

Enclosing interface:

DockerClient

public static class DockerClient.ListContainersParam
extends Object

Parameters for DockerClient.listContainers(ListContainersParam...)

Field Summary

Fields

Modifier and Type	Field and Description
private String	name
private String	value

Constructor Summary

Constructors

Constructor and Description
ListContainersParam(String name, String value)

Method Summary

Modifier and Type	Method and Description
static DockerClient.ListContainersParam	allContainers() Show all containers.
static DockerClient.ListContainersParam	allContainers(boolean all) Show all containers.
static DockerClient.ListContainersParam	containersCreatedBefore(String id) Show only containers created before id, include non-running ones.
static DockerClient.ListContainersParam	containersCreatedSince(String id) Show only containers created since id, include non-running ones.
static DockerClient.ListContainersParam	create(String name, String value) Create a custom parameter.
static DockerClient.ListContainersParam	exitedContainers() Show exited containers.
static DockerClient.ListContainersParam	limitContainers(Integer limit) Show limit last created containers, include non-running ones.
String	name() Parameter name.
String	value() Parameter value.
static DockerClient.ListContainersParam	withContainerSizes(Boolean size) Show the containers sizes.

Methods inherited from class java.lang.Object

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

Field Detail

name

private final String name

value

private final String value

Constructor Detail

ListContainersParam

public ListContainersParam(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

allContainers

public static DockerClient.ListContainersParam allContainers()

Show all containers. Only running containers are shown by default

Returns:

ListContainersParam

allContainers

public static DockerClient.ListContainersParam allContainers(boolean all)

Show all containers. Only running containers are shown by default

Parameters:

all - Whether to show all containers

Returns:

ListContainersParam

exitedContainers

public static DockerClient.ListContainersParam exitedContainers()
                                                         throws UnsupportedEncodingException

Show exited containers.

Returns:

ListContainersParam

Throws:

UnsupportedEncodingException

limitContainers

public static DockerClient.ListContainersParam limitContainers(Integer limit)

Show limit last created containers, include non-running ones.

Parameters:

limit - Limit for number of containers to list

Returns:

ListContainersParam

containersCreatedSince

public static DockerClient.ListContainersParam containersCreatedSince(String id)

Show only containers created since id, include non-running ones.

Parameters:

id - container ID

Returns:

ListContainersParam

containersCreatedBefore

public static DockerClient.ListContainersParam containersCreatedBefore(String id)

Show only containers created before id, include non-running ones.

Parameters:

id - container ID

Returns:

ListContainersParam

withContainerSizes

public static DockerClient.ListContainersParam withContainerSizes(Boolean size)

Show the containers sizes.

Parameters:

size - Whether to show container sizes

Returns:

ListContainersParam

create

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

Create a custom parameter.

Parameters:

name - custom name

value - custom value

Returns:

ListContainersParam