Package com.spotify.docker.client
Class DockerClient.ListContainersParam
java.lang.Object
com.spotify.docker.client.DockerClient.Param
com.spotify.docker.client.DockerClient.ListContainersParam
- Direct Known Subclasses:
DockerClient.ListContainersFilterParam
- Enclosing interface:
DockerClient
Parameters for
DockerClient.listContainers(ListContainersParam...)
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionShow all containers.allContainers
(boolean all) Show all containers.Show only containers created before id, include non-running ones.Show only containers created since id, include non-running ones.Create a custom parameter.Deprecated.Create a "filters" query param from a key/value pair.limitContainers
(Integer limit) Showlimit
last created containers, include non-running ones.withContainerSizes
(Boolean size) Show the containers sizes.withExitStatus
(int exitStatus) Show exited containers with given exit status.Show containers with a label.Show containers with a label value.Show created containers.Show exited containers.Show paused containers.Show restarting containers.Show running containers.Methods inherited from class com.spotify.docker.client.DockerClient.Param
equals, hashCode, name, value
-
Constructor Details
-
ListContainersParam
-
-
Method Details
-
create
Create a custom parameter.- Parameters:
name
- custom namevalue
- custom value- Returns:
- ListContainersParam
-
filter
Create a "filters" query param from a key/value pair.- Parameters:
key
- Type of filtervalue
- Value of filter- Returns:
- ListContainersParam
-
allContainers
Show all containers. Only running containers are shown by default- Returns:
- ListContainersParam
-
allContainers
Show all containers. Only running containers are shown by default- Parameters:
all
- Whether to show all containers- Returns:
- ListContainersParam
-
limitContainers
Showlimit
last created containers, include non-running ones.- Parameters:
limit
- Limit for number of containers to list- Returns:
- ListContainersParam
-
containersCreatedSince
Show only containers created since id, include non-running ones.- Parameters:
id
- container ID- Returns:
- ListContainersParam
-
containersCreatedBefore
Show only containers created before id, include non-running ones.- Parameters:
id
- container ID- Returns:
- ListContainersParam
-
withContainerSizes
Show the containers sizes.- Parameters:
size
- Whether to show container sizes- Returns:
- ListContainersParam
-
withExitStatus
Show exited containers with given exit status.- Parameters:
exitStatus
- Integer exit status- Returns:
- ListContainersParam
-
withStatusCreated
Show created containers.- Returns:
- ListContainersParam
-
withStatusRestarting
Show restarting containers.- Returns:
- ListContainersParam
-
withStatusRunning
Show running containers.- Returns:
- ListContainersParam
-
withStatusPaused
Show paused containers.- Returns:
- ListContainersParam
-
withStatusExited
Show exited containers.- Returns:
- ListContainersParam
-
exitedContainers
Deprecated.Replaced bywithStatusExited()
Show exited containers.- Returns:
- ListContainersParam
-
withLabel
Show containers with a label value.- Parameters:
label
- The label to filter onvalue
- The value of the label- Returns:
- ListContainersParam
-
withLabel
Show containers with a label.- Parameters:
label
- The label to filter on- Returns:
- ListContainersParam
-
withStatusExited()