Package org.mandas.docker.client
Class DockerClient.ListImagesParam
- java.lang.Object
-
- org.mandas.docker.client.DockerClient.Param
-
- org.mandas.docker.client.DockerClient.ListImagesParam
-
- Direct Known Subclasses:
DockerClient.ListImagesFilterParam
- Enclosing interface:
- DockerClient
public static class DockerClient.ListImagesParam extends DockerClient.Param
Parameters forDockerClient.listImages(ListImagesParam...)
.
-
-
Constructor Summary
Constructors Constructor Description ListImagesParam(String name, String value)
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static DockerClient.ListImagesParam
allImages()
Show all images.static DockerClient.ListImagesParam
allImages(boolean all)
Show all images.static DockerClient.ListImagesParam
byName(String name)
Show images by name.static DockerClient.ListImagesParam
create(String name, String value)
Create a custom parameter.static DockerClient.ListImagesParam
danglingImages()
Show dangling images only.static DockerClient.ListImagesParam
danglingImages(boolean dangling)
Enable or disable dangling image filter.static DockerClient.ListImagesParam
digests()
Show digests.static DockerClient.ListImagesParam
filter(String name, String value)
Create a custom filter.static DockerClient.ListImagesParam
withLabel(String label)
Show images with a label.static DockerClient.ListImagesParam
withLabel(String label, String value)
Show images with a label value.-
Methods inherited from class org.mandas.docker.client.DockerClient.Param
equals, hashCode, name, value
-
-
-
-
Method Detail
-
create
public static DockerClient.ListImagesParam create(String name, String value)
Create a custom parameter.- Parameters:
name
- of parametervalue
- of parameter- Returns:
- ListImagesParam
-
filter
public static DockerClient.ListImagesParam filter(String name, String value)
Create a custom filter.- Parameters:
name
- of filtervalue
- 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 onvalue
- 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
-
-