Package org.mandas.docker.client

Class DockerClient.ListNetworksParam

java.lang.Object

org.mandas.docker.client.DockerClient.Param

org.mandas.docker.client.DockerClient.ListNetworksParam

Direct Known Subclasses:

DockerClient.ListNetworksFilterParam

Enclosing interface:

DockerClient

public static class DockerClient.ListNetworksParam
extends DockerClient.Param

Parameters for DockerClient.listNetworks(ListNetworksParam...)

Since:

Docker 1.10, API version 1.22

Method Summary

Modifier and Type	Method	Description
static DockerClient.ListNetworksParam	builtInNetworks()	Return built-in networks only.
static DockerClient.ListNetworksParam	byNetworkId(String id)	Filter networks by ID.
static DockerClient.ListNetworksParam	byNetworkName(String name)	Filter networks by name.
static DockerClient.ListNetworksParam	customNetworks()	Return user-defined (custom) networks only.
static DockerClient.ListNetworksParam	dangling()	Filter dagling networks.
static DockerClient.ListNetworksParam	filter(String name, String value)	Create a custom filter.
static DockerClient.ListNetworksParam	withDriver(String driver)	Filter networks by network driver.
static DockerClient.ListNetworksParam	withLabel(String label)	Return networks with a label.
static DockerClient.ListNetworksParam	withLabel(String label, String value)	Return networks with a label value.
static DockerClient.ListNetworksParam	withType(Network.Type type)	Filter networks by network type.

Methods inherited from class org.mandas.docker.client.DockerClient.Param

equals, hashCode, name, value

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

filter

public static DockerClient.ListNetworksParam filter(String name,
 String value)

Create a custom filter.

Parameters:

name - of filter

value - of filter

Returns:

ListNetworksParam

Since:

Docker 1.10, API version 1.22

byNetworkId

public static DockerClient.ListNetworksParam byNetworkId(String id)

Filter networks by ID.

Parameters:

id - Matches all or part of a network ID.

Returns:

The ListNetworksParam for the given ID.

Since:

Docker 1.10, API version 1.22

byNetworkName

public static DockerClient.ListNetworksParam byNetworkName(String name)

Filter networks by name.

Parameters:

name - Matches all or part of a network name.

Returns:

The ListNetworksParam for the given name.

Since:

Docker 1.10, API version 1.22

withDriver

public static DockerClient.ListNetworksParam withDriver(String driver)

Filter networks by network driver.

Parameters:

driver - The network driver name.

Returns:

The ListNetworksParam for the given driver.

Since:

Docker 1.12, API version 1.24

withType

public static DockerClient.ListNetworksParam withType(Network.Type type)

Filter networks by network type. There are two types of networks: those built-in into Docker and custom networks created by users.

Parameters:

type - The network type.

Returns:

The ListNetworksParam for the given type.

Since:

Docker 1.10, API version 1.22

See Also:

• builtInNetworks()
• customNetworks()

dangling

public static DockerClient.ListNetworksParam dangling()

Filter dagling networks. Networks not used by a container/service.

Returns:

The ListNetworksParam for the given type.

Since:

Docker 19.03, API version 1.40

builtInNetworks

public static DockerClient.ListNetworksParam builtInNetworks()

Return built-in networks only.

Returns:

The ListNetworksParam for built-in networks.

Since:

Docker 1.10, API version 1.22

See Also:

• withType(org.mandas.docker.client.messages.Network.Type)
• customNetworks()

customNetworks

public static DockerClient.ListNetworksParam customNetworks()

Return user-defined (custom) networks only.

Returns:

The ListNetworksParam for user-defined networks.

Since:

Docker 1.10, API version 1.22

See Also:

• withType(org.mandas.docker.client.messages.Network.Type)
• builtInNetworks()

withLabel

public static DockerClient.ListNetworksParam withLabel(String label,
 String value)

Return networks with a label value.

Parameters:

label - The label to filter on

value - The value of the label

Returns:

ListNetworksParam

Since:

Docker 1.12, API version 1.24

withLabel

public static DockerClient.ListNetworksParam withLabel(String label)

Return networks with a label.

Parameters:

label - The label to filter on

Returns:

ListNetworksParam

Since:

Docker 1.12, API version 1.24