com.spotify.docker.client

Class DockerClient.ListImagesParam

java.lang.Object

com.spotify.docker.client.DockerClient.ListImagesParam

Direct Known Subclasses:

DockerClient.ListImagesFilterParam

Enclosing interface:

DockerClient

public static class DockerClient.ListImagesParam
extends Object

Parameters for DockerClient.listImages(ListImagesParam...)

Field Summary

Fields

Modifier and Type	Field and Description
private String	name
private String	value

Constructor Summary

Constructors

Constructor and Description
ListImagesParam(String name, String value)

Method Summary

Modifier and Type	Method and Description
static DockerClient.ListImagesParam	allImages() Show all images.
static DockerClient.ListImagesParam	allImages(boolean all) Show all images.
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	filter(String name, String value) Create a custom filter.
String	name() Parameter name.
String	value() Parameter value.
static DockerClient.ListImagesParam	withLabel(Map<String,String> labels) Show images with a label value
static DockerClient.ListImagesParam	withLabel(String key) Show images with a label
static DockerClient.ListImagesParam	withLabel(String key, String value) Show images with a label value

Methods inherited from class java.lang.Object

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

Field Detail

name

private final String name

value

private final String value

Constructor Detail

ListImagesParam

public ListImagesParam(String name,
                       String value)

Method Detail

name

public String name()

Parameter name.

Returns:

name of parameter

value

public String value()

Parameter value.

Returns:

value of parameter

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

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

filter

public static DockerClient.ListImagesParam filter(String name,
                                                  String value)

Create a custom filter.

Parameters:

name - of filter

value - of filter

Returns:

ListImagesParam

withLabel

public static DockerClient.ListImagesParam withLabel(String key,
                                                     String value)

Show images with a label value

Parameters:

key - of label

value - of label

Returns:

ListImagesParam

withLabel

public static DockerClient.ListImagesParam withLabel(String key)

Show images with a label

Parameters:

key - of label

Returns:

ListImagesParam

withLabel

public static DockerClient.ListImagesParam withLabel(Map<String,String> labels)

Show images with a label value

Parameters:

labels - Map of label key, label value pairs

Returns:

ListImagesParam

create

public static DockerClient.ListImagesParam create(String name,
                                                  String value)

Create a custom parameter.

Parameters:

name - of parameter

value - of parameter

Returns:

ListImagesParam