docker.models.configs.ConfigCollection

class documentation

class ConfigCollection(Collection): (source)

Configs on the Docker server.

Method	`create`	Undocumented
Method	`get`	Get a config.
Method	`list`	List configs. Similar to the ``docker config ls`` command.

Inherited from Collection:

Method	`__call__`	Undocumented
Method	`__init__`	Undocumented
Method	`prepare_model`	Create a model from a set of attributes.
Class Variable	`model`	Undocumented
Instance Variable	`client`	Undocumented

def create(self, **kwargs): (source) ¶

overrides docker.models.resource.Collection.create

Undocumented

def get(self, config_id): (source) ¶

overrides docker.models.resource.Collection.get

Get a config. Args: config_id (str): Config ID. Returns: (:py:class:`Config`): The config. Raises: :py:class:`docker.errors.NotFound` If the config does not exist. :py:class:`docker.errors.APIError` If the server returns an error.

def list(self, **kwargs): (source) ¶

overrides docker.models.resource.Collection.list

List configs. Similar to the ``docker config ls`` command. Args: filters (dict): Server-side list filtering options. Returns: (list of :py:class:`Config`): The configs. Raises: :py:class:`docker.errors.APIError` If the server returns an error.