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
Parameters for
DockerClient.listVolumes(ListVolumesParam...)
.- Since:
- Docker 1.9, API version 1.21
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiondangling()
Show dangling volumes only.Enable or disable dangling volume filter.Filter volumes by volume driver.Create a custom filter.Filter volumes by name.Methods inherited from class com.spotify.docker.client.DockerClient.Param
equals, hashCode, name, value
-
Constructor Details
-
ListVolumesParam
-
-
Method Details
-
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
Create a custom filter.- Parameters:
name
- of filtervalue
- of filter- Returns:
- ListVolumesParam
- Since:
- Docker 1.9, API version 1.21
-
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
Enable or disable dangling volume filter.- Parameters:
dangling
- Whether to list dangling images- Returns:
- ListVolumesParam
-
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
-