com.github.dockerjava.api.command

Interface ListTasksCmd

All Superinterfaces:

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

All Known Implementing Classes:

ListTasksCmdImpl

public interface ListTasksCmd
extends SyncDockerCmd<java.util.List<Task>>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ListTasksCmd.Exec

Method Summary

Modifier and Type	Method and Description
java.util.List<Task>	exec()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getFilters()
ListTasksCmd	withIdFilter(java.lang.String... ids)
ListTasksCmd	withLabelFilter(java.util.Map<java.lang.String,java.lang.String> labels)
ListTasksCmd	withLabelFilter(java.lang.String... labels)
ListTasksCmd	withNameFilter(java.lang.String... names)
ListTasksCmd	withNodeFilter(java.lang.String... nodeNames)
ListTasksCmd	withServiceFilter(java.lang.String... serviceNames)
ListTasksCmd	withStateFilter(TaskState... desiredState)

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

close

Method Detail

getFilters

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

withLabelFilter

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

Parameters:

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

withLabelFilter

ListTasksCmd withLabelFilter(java.lang.String... labels)

Parameters:

labels - - Show only tasks with the passed labels.

withIdFilter

ListTasksCmd withIdFilter(java.lang.String... ids)

Parameters:

ids - Task id(s)

withNameFilter

ListTasksCmd withNameFilter(java.lang.String... names)

Parameters:

names - Task name(s)

withNodeFilter

ListTasksCmd withNodeFilter(java.lang.String... nodeNames)

Parameters:

nodeNames - Node id(s) or name(s)

withServiceFilter

ListTasksCmd withServiceFilter(java.lang.String... serviceNames)

Parameters:

serviceNames - Service name(s)

withStateFilter

ListTasksCmd withStateFilter(TaskState... desiredState)

Parameters:

desiredState - The desired-state filter can take the values running, shutdown, or accepted.

exec

java.util.List<Task> exec()
                   throws NotFoundException

Specified by:

exec in interface SyncDockerCmd<java.util.List<Task>>

Throws:

NotFoundException