com.github.dockerjava.api.command

Interface ListContainersCmd

All Superinterfaces:

AutoCloseable, Closeable, DockerCmd<List<Container>>, SyncDockerCmd<List<Container>>

public interface ListContainersCmd
extends SyncDockerCmd<List<Container>>

List containers

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ListContainersCmd.Exec

Method Summary

Modifier and Type	Method and Description
String	getBeforeId()
Map<String,List<String>>	getFilters()
Integer	getLimit()
String	getSinceId()
Boolean	hasShowAllEnabled()
Boolean	hasShowSizeEnabled()
ListContainersCmd	withAncestorFilter(Collection<String> ancestor)
ListContainersCmd	withBefore(String before)
ListContainersCmd	withExitedFilter(Integer exited)
ListContainersCmd	withFilter(String filterName, Collection<String> filterValues)
ListContainersCmd	withIdFilter(Collection<String> id)
ListContainersCmd	withLabelFilter(Collection<String> labels)
ListContainersCmd	withLabelFilter(Map<String,String> labels)
ListContainersCmd	withLimit(Integer limit)
ListContainersCmd	withNameFilter(Collection<String> name)
ListContainersCmd	withNetworkFilter(Collection<String> network)
ListContainersCmd	withShowAll(Boolean showAll)
ListContainersCmd	withShowSize(Boolean showSize)
ListContainersCmd	withSince(String since)
ListContainersCmd	withStatusFilter(Collection<String> status)
ListContainersCmd	withVolumeFilter(Collection<String> volume)

Methods inherited from interface com.github.dockerjava.api.command.SyncDockerCmd

exec

Methods inherited from interface com.github.dockerjava.api.command.DockerCmd

close

Method Detail

getBeforeId

@CheckForNull
String getBeforeId()

getFilters

@CheckForNull
Map<String,List<String>> getFilters()

getLimit

@CheckForNull
Integer getLimit()

getSinceId

@CheckForNull
String getSinceId()

hasShowAllEnabled

@CheckForNull
Boolean hasShowAllEnabled()

hasShowSizeEnabled

@CheckForNull
Boolean hasShowSizeEnabled()

withBefore

ListContainersCmd withBefore(String before)

Parameters:

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

withNameFilter

ListContainersCmd withNameFilter(Collection<String> name)

Parameters:

name - - Show only containers that has the container's name

withIdFilter

ListContainersCmd withIdFilter(Collection<String> id)

Parameters:

id - - Show only containers that has the container's id

withAncestorFilter

ListContainersCmd withAncestorFilter(Collection<String> ancestor)

Parameters:

ancestor - - Show only containers created from an image or a descendant.

withVolumeFilter

ListContainersCmd withVolumeFilter(Collection<String> volume)

Parameters:

volume - - Show only containers with volume name or mount point destination

withNetworkFilter

ListContainersCmd withNetworkFilter(Collection<String> network)

Parameters:

network - - Show only containers with network id or network name

withExitedFilter

ListContainersCmd withExitedFilter(Integer exited)

Parameters:

exited - - Show only containers that exited with the passed exitcode.

withStatusFilter

ListContainersCmd withStatusFilter(Collection<String> status)

Parameters:

status - - Show only containers with the passed status (created|restarting|running|paused|exited).

withLabelFilter

ListContainersCmd withLabelFilter(Collection<String> labels)

Parameters:

labels - - Show only containers with the passed labels.

withLabelFilter

ListContainersCmd withLabelFilter(Map<String,String> labels)

Parameters:

labels - - Show only containers with the passed labels. Labels is a Map that contains label keys and values

withLimit

ListContainersCmd withLimit(Integer limit)

Parameters:

limit - - Show `limit` last created containers, include non-running ones. There is no limit by default.

withShowAll

ListContainersCmd withShowAll(Boolean showAll)

Parameters:

showAll - - Show all containers. Only running containers are shown by default.

withShowSize

ListContainersCmd withShowSize(Boolean showSize)

Parameters:

showSize - - Show the containers sizes. This is false by default.

withSince

ListContainersCmd withSince(String since)

Parameters:

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

withFilter

ListContainersCmd withFilter(String filterName,
                             Collection<String> filterValues)

Parameters:

filterName -

filterValues - - Show only containers where the filter matches the given values