Specifies how to list images.
More...
|
| bool? | BuiltInNetworksFilter [get, set] |
| | Gets or sets a filter for built-in networks. Built-in networks are ones provided by Docker, as opposed to custom networks that are created by Docker's consumers. True means that only built-in networks will be returned. False means that only custom networks will be returned. Null (the default) means not to filter by built-in vs. custom. More...
|
| |
| bool? | DanglingNetworksFilter [get, set] |
| | Gets or sets a filter for dangling networks. Dangling networks are ones that are not currently in use by any containers. True means that only dangling networks will be returned; false means only non-dangling networks will be returned; and null (the default) means not to filter by whether the network is dangling. More...
|
| |
| IEnumerable< string >? | DriverFilter [get, set] |
| | Gets or sets a set of values naming the drivers to filter by. If this is not null, only networks that use one of the named drivers will be returned. The default is null, which means not to filter by driver. This field is case-sensitive. More...
|
| |
| IEnumerable< string >? | IdFilter [get, set] |
| | Gets or sets a set of ID fragments to filter by. If this is not null, only networks whose full IDs contain one or more of these values will be returned. The default is null, which means not to filter by ID. This field is case-sensitive. More...
|
| |
| List< string > | LabelExistsFilters = new() [get] |
| | Gets a list of labels to filter by. Only networks 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 networks that have all of the given labels set to the given values will be returned. More...
|
| |
| IEnumerable< string >? | NameFilter [get, set] |
| | Gets or sets a set of name fragments to filter by. If this is not null, only networks whose names contain one or more of these values will be returned. The default is null, which means not to filter by name. This field is case-sensitive. More...
|
| |
| NetworkScope? | ScopeFilter [get, set] |
| | Gets or sets a network scope to filter for. If this is not null, only networks with the indicated scope will be returned. The default is null, which means to not filter by scope. More...
|
| |
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?
◆ BuiltInNetworksFilter
| bool? DockerSdk.Networks.ListNetworksOptions.BuiltInNetworksFilter |
|
getset |
Gets or sets a filter for built-in networks. Built-in networks are ones provided by Docker, as opposed to custom networks that are created by Docker's consumers. True means that only built-in networks will be returned. False means that only custom networks will be returned. Null (the default) means not to filter by built-in vs. custom.
◆ DanglingNetworksFilter
| bool? DockerSdk.Networks.ListNetworksOptions.DanglingNetworksFilter |
|
getset |
Gets or sets a filter for dangling networks. Dangling networks are ones that are not currently in use by any containers. True means that only dangling networks will be returned; false means only non-dangling networks will be returned; and null (the default) means not to filter by whether the network is dangling.
◆ DriverFilter
| IEnumerable<string>? DockerSdk.Networks.ListNetworksOptions.DriverFilter |
|
getset |
Gets or sets a set of values naming the drivers to filter by. If this is not null, only networks that use one of the named drivers will be returned. The default is null, which means not to filter by driver. This field is case-sensitive.
◆ IdFilter
| IEnumerable<string>? DockerSdk.Networks.ListNetworksOptions.IdFilter |
|
getset |
Gets or sets a set of ID fragments to filter by. If this is not null, only networks whose full IDs contain one or more of these values will be returned. The default is null, which means not to filter by ID. This field is case-sensitive.
The match can be anywhere in the ID, including in parts of the ID that aren't visible in the short form of the ID.
◆ LabelExistsFilters
| List<string> DockerSdk.Networks.ListNetworksOptions.LabelExistsFilters = new() |
|
get |
Gets a list of labels to filter by. Only networks 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.Networks.ListNetworksOptions.LabelValueFilters = new() |
|
get |
Gets a set of label-value pairs to filter by. Only networks 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.
◆ NameFilter
| IEnumerable<string>? DockerSdk.Networks.ListNetworksOptions.NameFilter |
|
getset |
Gets or sets a set of name fragments to filter by. If this is not null, only networks whose names contain one or more of these values will be returned. The default is null, which means not to filter by name. This field is case-sensitive.
The match can be anywhere in the name–not just at the beginning.
◆ ScopeFilter
| NetworkScope? DockerSdk.Networks.ListNetworksOptions.ScopeFilter |
|
getset |
Gets or sets a network scope to filter for. If this is not null, only networks with the indicated scope will be returned. The default is null, which means to not filter by scope.
The documentation for this class was generated from the following file:
- Networks/ListNetworksOptions.cs
