Package com.spotify.docker.client

Class DockerClient.ListVolumesParam

java.lang.Object

com.spotify.docker.client.DockerClient.Param

com.spotify.docker.client.DockerClient.ListVolumesParam

Direct Known Subclasses:

DockerClient.ListVolumesFilterParam

Enclosing interface:

DockerClient

public static class DockerClient.ListVolumesParam
extends DockerClient.Param

Parameters for DockerClient.listVolumes(ListVolumesParam...).

Since:

Docker 1.9, API version 1.21

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ListVolumesParam(java.lang.String name, java.lang.String value)

Method Summary

Modifier and Type	Method	Description
static DockerClient.ListVolumesParam	dangling()	Show dangling volumes only.
static DockerClient.ListVolumesParam	dangling(java.lang.Boolean dangling)	Enable or disable dangling volume filter.
static DockerClient.ListVolumesParam	driver(java.lang.String driver)	Filter volumes by volume driver.
static DockerClient.ListVolumesParam	filter(java.lang.String name, java.lang.String value)	Create a custom filter.
static DockerClient.ListVolumesParam	name(java.lang.String name)	Filter volumes by name.

Methods inherited from class com.spotify.docker.client.DockerClient.Param

equals, hashCode, name, value

Methods inherited from class java.lang.Object

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

Constructor Detail

ListVolumesParam

private ListVolumesParam(java.lang.String name,
                         java.lang.String value)

Method Detail

name

public static DockerClient.ListVolumesParam name(java.lang.String name)

Filter volumes by name.

Parameters:

name - Matches all or part of a volume name.

Returns:

ListVolumesParam

Since:

Docker 1.12, API version 1.24

filter

public static DockerClient.ListVolumesParam filter(java.lang.String name,
                                                   java.lang.String value)

Create a custom filter.

Parameters:

name - of filter

value - of filter

Returns:

ListVolumesParam

Since:

Docker 1.9, API version 1.21

dangling

public static DockerClient.ListVolumesParam dangling()

Show dangling volumes only. A dangling volume is one which is not referenced by any container. By default both dangling and non-dangling will be shown.

Returns:

ListVolumesParam

Since:

Docker 1.9, API version 1.21

dangling

public static DockerClient.ListVolumesParam dangling(java.lang.Boolean dangling)

Enable or disable dangling volume filter.

Parameters:

dangling - Whether to list dangling images

Returns:

ListVolumesParam

driver

public static DockerClient.ListVolumesParam driver(java.lang.String driver)

Filter volumes by volume driver.

Parameters:

driver - Matches all or part of a volume driver name.

Returns:

ListVolumesParam

Since:

Docker 1.12, API version 1.24