docker.models.images.RegistryData

class documentation

class RegistryData(Model): (source)

Image metadata stored on the registry, including available platforms.

Method	`__init__`	Undocumented
Method	`has_platform`	Check whether the given platform identifier is available for this digest.
Method	`pull`	Pull the image digest.
Method	`reload`	Load this object from the server again and update ``attrs`` with the new data.
Instance Variable	`attrs`	Undocumented
Instance Variable	`image_name`	Undocumented
Property	`id`	The ID of the object.
Property	`short_id`	The ID of the image truncated to 12 characters, plus the ``sha256:`` prefix.

Inherited from Model:

Method	`__eq__`	Undocumented
Method	`__hash__`	Undocumented
Method	`__repr__`	Undocumented
Class Variable	`id_attribute`	Undocumented
Instance Variable	`client`	Undocumented
Instance Variable	`collection`	Undocumented

def __init__(self, image_name, *args, **kwargs): (source) ¶

overrides docker.models.resource.Model.__init__

Undocumented

def has_platform(self, platform): (source) ¶

Check whether the given platform identifier is available for this digest. Args: platform (str or dict): A string using the ``os[/arch[/variant]]`` format, or a platform dictionary. Returns: (bool): ``True`` if the platform is recognized as available, ``False`` otherwise. Raises: :py:class:`docker.errors.InvalidArgument` If the platform argument is not a valid descriptor.

def pull(self, platform=None): (source) ¶

Pull the image digest. Args: platform (str): The platform to pull the image for. Default: ``None`` Returns: (:py:class:`Image`): A reference to the pulled image.

def reload(self): (source) ¶

overrides docker.models.resource.Model.reload

Load this object from the server again and update ``attrs`` with the new data.

attrs = (source) ¶

overrides docker.models.resource.Model.attrs

Undocumented

image_name = (source) ¶

Undocumented

@property
id = (source) ¶

overrides docker.models.resource.Model.id

The ID of the object.

@property
short_id = (source) ¶

overrides docker.models.resource.Model.short_id

The ID of the image truncated to 12 characters, plus the ``sha256:`` prefix.