Class DockerClient.ListImagesParam

java.lang.Object
com.spotify.docker.client.DockerClient.Param
com.spotify.docker.client.DockerClient.ListImagesParam
Direct Known Subclasses:
DockerClient.ListImagesFilterParam
Enclosing interface:
DockerClient

public static class DockerClient.ListImagesParam extends DockerClient.Param
  • Constructor Details

    • ListImagesParam

      public ListImagesParam(String name, String value)
  • Method Details

    • create

      public static DockerClient.ListImagesParam create(String name, String value)
      Create a custom parameter.
      Parameters:
      name - of parameter
      value - of parameter
      Returns:
      ListImagesParam
    • filter

      public static DockerClient.ListImagesParam filter(String name, String value)
      Create a custom filter.
      Parameters:
      name - of filter
      value - of filter
      Returns:
      ListImagesParam
    • allImages

      public static DockerClient.ListImagesParam allImages()
      Show all images. Only intermediate image layers are shown by default.
      Returns:
      ListImagesParam
    • allImages

      public static DockerClient.ListImagesParam allImages(boolean all)
      Show all images. Only intermediate image layers are shown by default.
      Parameters:
      all - Whether to list all images
      Returns:
      ListImagesParam
    • digests

      public static DockerClient.ListImagesParam digests()
      Show digests.
      Returns:
      ListImagesParam
    • danglingImages

      public static DockerClient.ListImagesParam danglingImages()
      Show dangling images only. A dangling image is one which does not have a repository name. By default both dangling and non-dangling will be shown.
      Returns:
      ListImagesParam
    • danglingImages

      public static DockerClient.ListImagesParam danglingImages(boolean dangling)
      Enable or disable dangling image filter.
      Parameters:
      dangling - Whether to list dangling images
      Returns:
      ListImagesParam
    • withLabel

      public static DockerClient.ListImagesParam withLabel(String label, String value)
      Show images with a label value.
      Parameters:
      label - The label to filter on
      value - The value of the label
      Returns:
      ListImagesParam
    • withLabel

      public static DockerClient.ListImagesParam withLabel(String label)
      Show images with a label.
      Parameters:
      label - The label to filter on
      Returns:
      ListImagesParam
    • byName

      public static DockerClient.ListImagesParam byName(String name)
      Show images by name. Can use RepoTags or RepoDigests as valid inputs.
      Parameters:
      name - Name of the image to filter on
      Returns:
      ListImagesParam