com.github.dockerjava.api.command

Interface ListContainersCmd

All Superinterfaces:

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

All Known Implementing Classes:

ListContainersCmdImpl

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	withBefore(String before)
ListContainersCmd	withExitcodeFilter(Integer exitcode)
ListContainersCmd	withLabelFilter(Map<String,String> labels)
ListContainersCmd	withLabelFilter(String... labels)
ListContainersCmd	withLimit(Integer limit)
ListContainersCmd	withShowAll(Boolean showAll)
ListContainersCmd	withShowSize(Boolean showSize)
ListContainersCmd	withSince(String since)
ListContainersCmd	withStatusFilter(String status)

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.

withExitcodeFilter

ListContainersCmd withExitcodeFilter(Integer exitcode)

Parameters:

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

withStatusFilter

ListContainersCmd withStatusFilter(String status)

Parameters:

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

withLabelFilter

ListContainersCmd withLabelFilter(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.