DockerClient.ListContainersParam (docker-client 6.1.1 API)

java.lang.Object
- com.spotify.docker.client.DockerClient.ListContainersParam

Direct Known Subclasses:

DockerClient.ListContainersFilterParam

Enclosing interface:

DockerClient
```
public static class DockerClient.ListContainersParam
extends Object
```
Parameters for DockerClient.listContainers(ListContainersParam...)

Constructor Summary

Constructors
Constructor and Description

ListContainersParam(String name, String value)

Constructors
Constructor and Description
`ListContainersParam(String name, String value)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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()` Deprecated. Replaced by `withStatusExited()`
`static DockerClient.ListContainersParam`	`filter(String key, String value)` Create a "filters" query param from a key/value pair
`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.
`static DockerClient.ListContainersParam`	`withExitStatus(int exitStatus)` Show exited containers with given exit status.
`static DockerClient.ListContainersParam`	`withLabel(String label)` Show containers with a label.
`static DockerClient.ListContainersParam`	`withLabel(String label, String value)` Show containers with a label value.
`static DockerClient.ListContainersParam`	`withStatusCreated()` Show created containers.
`static DockerClient.ListContainersParam`	`withStatusExited()` Show exited containers.
`static DockerClient.ListContainersParam`	`withStatusPaused()` Show paused containers.
`static DockerClient.ListContainersParam`	`withStatusRestarting()` Show restarting containers.
`static DockerClient.ListContainersParam`	`withStatusRunning()` Show running containers.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ListContainersParam
```
public ListContainersParam(String name,
                           String value)
```
- Method Detail
  - create
```
public static DockerClient.ListContainersParam create(String name,
                                                      String value)
```
    Create a custom parameter.
    
    Parameters:
    
    name - custom name
    
    value - custom value
    
    Returns:
    
    ListContainersParam
  - filter
```
public static DockerClient.ListContainersParam filter(String key,
                                                      String value)
```
    Create a "filters" query param from a key/value pair
    
    Parameters:
    
    key - Type of filter
    
    value - Value of filter
    
    Returns:
    
    ListContainersParam
  - 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
  - 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
  - withExitStatus
```
public static DockerClient.ListContainersParam withExitStatus(int exitStatus)
```
    Show exited containers with given exit status.
    
    Parameters:
    
    exitStatus - Integer exit status
    
    Returns:
    
    ListContainersParam
  - withStatusCreated
```
public static DockerClient.ListContainersParam withStatusCreated()
```
    Show created containers.
    
    Returns:
    
    ListContainersParam
  - withStatusRestarting
```
public static DockerClient.ListContainersParam withStatusRestarting()
```
    Show restarting containers.
    
    Returns:
    
    ListContainersParam
  - withStatusRunning
```
public static DockerClient.ListContainersParam withStatusRunning()
```
    Show running containers.
    
    Returns:
    
    ListContainersParam
  - withStatusPaused
```
public static DockerClient.ListContainersParam withStatusPaused()
```
    Show paused containers.
    
    Returns:
    
    ListContainersParam
  - withStatusExited
```
public static DockerClient.ListContainersParam withStatusExited()
```
    Show exited containers.
    
    Returns:
    
    ListContainersParam
  - exitedContainers
```
@Deprecated
public static DockerClient.ListContainersParam exitedContainers()
```
    Deprecated. Replaced by withStatusExited()
    
    Show exited containers.
    
    Returns:
    
    ListContainersParam
  - withLabel
```
public static DockerClient.ListContainersParam withLabel(String label,
                                                         String value)
```
    Show containers with a label value.
    
    Parameters:
    
    label - The label to filter on
    
    value - The value of the label
    
    Returns:
    
    ListContainersParam
  - withLabel
```
public static DockerClient.ListContainersParam withLabel(String label)
```
    Show containers with a label.
    
    Parameters:
    
    label - The label to filter on
    
    Returns:
    
    ListContainersParam

Class DockerClient.ListContainersParam

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ListContainersParam

Method Detail

create

filter

name

value

allContainers

allContainers

limitContainers

containersCreatedSince

containersCreatedBefore

withContainerSizes

withExitStatus

withStatusCreated

withStatusRestarting

withStatusRunning

withStatusPaused

withStatusExited

exitedContainers

withLabel

withLabel