Specifies how to list images. More...

Properties
static ListImagesOptions	CommandLineDefaults `[get]`
	Gets options that are equivalent to the defaults for the `docker image ls` command. More...

bool?	DanglingImagesFilter `[get, set]`
	Gets or sets a filter for dangling images. True means that only dangling images will be returned; false means only non-dangling images will be returned; and null means not to filter by whether the image is dangling. More...

bool	HideIntermediateImages `[get, set]`
	Gets or sets a value indicating whether to filter out intermediate images. More...

List< string >	LabelExistsFilters = new() `[get]`
	Gets a list of labels to filter by. Only images that have all of the given labels will be returned. More...

Dictionary< string, string >	LabelValueFilters = new() `[get]`
	Gets a set of label-value pairs to filter by. Only images that have all of the given labels set to the given values will be returned. More...

List< string >	ReferencePatternFilters = new() `[get]`
	Gets a list of glob patterns to filter by. Only images with references matching one or more of the patterns will be returned. If this list is blank, pattern filters are not applied. More...

Detailed Description

Specifies how to list images.

TODO: when the caller uses more than one kind of filter, does the API use "or" logic or "and" logic?

Property Documentation

◆ CommandLineDefaults

ListImagesOptions DockerSdk.Images.ListImagesOptions.CommandLineDefaults

staticget

Gets options that are equivalent to the defaults for the docker image ls command.

◆ DanglingImagesFilter

bool? DockerSdk.Images.ListImagesOptions.DanglingImagesFilter

getset

Gets or sets a filter for dangling images. True means that only dangling images will be returned; false means only non-dangling images will be returned; and null means not to filter by whether the image is dangling.

◆ HideIntermediateImages

bool DockerSdk.Images.ListImagesOptions.HideIntermediateImages

getset

Gets or sets a value indicating whether to filter out intermediate images.

◆ LabelExistsFilters

List<string> DockerSdk.Images.ListImagesOptions.LabelExistsFilters = new()

get

Gets a list of labels to filter by. Only images that have all of the given labels will be returned.

If both this setting and LabelValueFilters are set, they are combined with "or" logic.

◆ LabelValueFilters

Dictionary<string, string> DockerSdk.Images.ListImagesOptions.LabelValueFilters = new()

get

Gets a set of label-value pairs to filter by. Only images that have all of the given labels set to the given values will be returned.

If both this setting and LabelExistsFilters are set, they are combined with "or" logic.

◆ ReferencePatternFilters

List<string> DockerSdk.Images.ListImagesOptions.ReferencePatternFilters = new()

get

Gets a list of glob patterns to filter by. Only images with references matching one or more of the patterns will be returned. If this list is blank, pattern filters are not applied.

The following matching patterns are respected:

* matches zero or more characters
? matches exactly one character
[...] matches exactly one character in the set

The patterns can match on the repository (in which case all tags for that repository are returned) or the repository:tag or the repository@digest. Patterns do not match against the ID.

Caution: If you use * without : or </c>, you might accidentally match more than you expect. For example, glob "a*b" will match "axb:1.0", "a:xb", and "ax@sha256:bf756fb1ae65adf866bd8c456593cd24beb6a0a061dedf42b26a993176745f6b". Even with : it's possible to accidentally match a digest, such as "a*:*b" matching "ax@sha256:bf756fb1ae65adf866bd8c456593cd24beb6a0a061dedf42b26a993176745f6b".

The documentation for this class was generated from the following file:

Images/ListImagesOptions.cs

Properties