com.github.dockerjava.api.command

Interface ListContainersCmd

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, DockerCmd<java.util.List<Container>>, SyncDockerCmd<java.util.List<Container>>

public interface ListContainersCmd
extends SyncDockerCmd<java.util.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
java.lang.String	getBeforeId()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getFilters()
java.lang.Integer	getLimit()
java.lang.String	getSinceId()
java.lang.Boolean	hasShowAllEnabled()
java.lang.Boolean	hasShowSizeEnabled()
ListContainersCmd	withAncestorFilter(java.util.Collection<java.lang.String> ancestor)
ListContainersCmd	withBefore(java.lang.String before)
ListContainersCmd	withExitedFilter(java.lang.Integer exited)
ListContainersCmd	withFilter(java.lang.String filterName, java.util.Collection<java.lang.String> filterValues)
ListContainersCmd	withIdFilter(java.util.Collection<java.lang.String> id)
ListContainersCmd	withLabelFilter(java.util.Collection<java.lang.String> labels)
ListContainersCmd	withLabelFilter(java.util.Map<java.lang.String,java.lang.String> labels)
ListContainersCmd	withLimit(java.lang.Integer limit)
ListContainersCmd	withNameFilter(java.util.Collection<java.lang.String> name)
ListContainersCmd	withNetworkFilter(java.util.Collection<java.lang.String> network)
ListContainersCmd	withShowAll(java.lang.Boolean showAll)
ListContainersCmd	withShowSize(java.lang.Boolean showSize)
ListContainersCmd	withSince(java.lang.String since)
ListContainersCmd	withStatusFilter(java.util.Collection<java.lang.String> status)
ListContainersCmd	withVolumeFilter(java.util.Collection<java.lang.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
java.lang.String getBeforeId()

getFilters

@CheckForNull
java.util.Map<java.lang.String,java.util.List<java.lang.String>> getFilters()

getLimit

@CheckForNull
java.lang.Integer getLimit()

getSinceId

@CheckForNull
java.lang.String getSinceId()

hasShowAllEnabled

@CheckForNull
java.lang.Boolean hasShowAllEnabled()

hasShowSizeEnabled

@CheckForNull
java.lang.Boolean hasShowSizeEnabled()

withBefore

ListContainersCmd withBefore(java.lang.String before)

Parameters:

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

withNameFilter

ListContainersCmd withNameFilter(java.util.Collection<java.lang.String> name)

Parameters:

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

withIdFilter

ListContainersCmd withIdFilter(java.util.Collection<java.lang.String> id)

Parameters:

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

withAncestorFilter

ListContainersCmd withAncestorFilter(java.util.Collection<java.lang.String> ancestor)

Parameters:

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

withVolumeFilter

ListContainersCmd withVolumeFilter(java.util.Collection<java.lang.String> volume)

Parameters:

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

withNetworkFilter

ListContainersCmd withNetworkFilter(java.util.Collection<java.lang.String> network)

Parameters:

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

withExitedFilter

ListContainersCmd withExitedFilter(java.lang.Integer exited)

Parameters:

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

withStatusFilter

ListContainersCmd withStatusFilter(java.util.Collection<java.lang.String> status)

Parameters:

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

withLabelFilter

ListContainersCmd withLabelFilter(java.util.Collection<java.lang.String> labels)

Parameters:

labels - - Show only containers with the passed labels.

withLabelFilter

ListContainersCmd withLabelFilter(java.util.Map<java.lang.String,java.lang.String> labels)

Parameters:

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

withLimit

ListContainersCmd withLimit(java.lang.Integer limit)

Parameters:

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

withShowAll

ListContainersCmd withShowAll(java.lang.Boolean showAll)

Parameters:

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

withShowSize

ListContainersCmd withShowSize(java.lang.Boolean showSize)

Parameters:

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

withSince

ListContainersCmd withSince(java.lang.String since)

Parameters:

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

withFilter

ListContainersCmd withFilter(java.lang.String filterName,
                             java.util.Collection<java.lang.String> filterValues)

Parameters:

filterName -

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