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
Since:
Docker 1.9, API version 1.21
  • Constructor Details

    • ListVolumesParam

      private ListVolumesParam(String name, String value)
  • Method Details

    • name

      public static DockerClient.ListVolumesParam name(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(String name, 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(Boolean dangling)
      Enable or disable dangling volume filter.
      Parameters:
      dangling - Whether to list dangling images
      Returns:
      ListVolumesParam
    • driver

      public static DockerClient.ListVolumesParam driver(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