/ 
API-Docker-0.004
/ API::Docker::Type::CreateImageInfo

NAME

API::Docker::Type::CreateImageInfo - One event of the stream a POST /images/create answers with

VERSION

version 0.004

DESCRIPTION

Generated from the CreateImageInfo definition of spec/v1.51.yaml, which the swagger leaves undescribed. The pull progress stream: POST /images/create answers 200 and then writes one of these objects per line. Like a build, a failed pull is still 200 and reports itself through errorDetail.

id

Undocumented upstream. Which layer the event is about: a short image ID, repeated across every event for that layer. t/fixtures/images_pull_stream.ndjson carries 55afa1ecc21d once and d529dd0c6e55 on three consecutive events. Serialised as id -- spelled out, because deriving it from the Perl name would produce Id.

error

Errors encountered during the operation.

> Deprecated: This field is deprecated since API v1.4, and will be omitted in a future API version. Use the information in errorDetail instead. Serialised as error -- spelled out, because deriving it from the Perl name would produce Error.

error_detail

Undocumented upstream. The failure, structured; the error field beside it carries the same text and the swagger deprecates it in favour of this one. A failed pull is still 200, so this is the verdict -- see API::Docker::Error::Stream. See API::Docker::Type::ErrorDetail. Serialised as errorDetail -- spelled out, because deriving it from the Perl name would produce ErrorDetail.

status

Undocumented upstream. The phase the layer named by "id" has reached, as text. The captured pull in t/fixtures/images_pull_stream.ndjson carries "Already exists", "Pulling fs layer" and "Download complete". Serialised as status -- spelled out, because deriving it from the Perl name would produce Status.

progress

Progress is a pre-formatted presentation of progressDetail.

> Deprecated: This field is deprecated since API v1.8, and will be omitted in a future API version. Use the information in progressDetail instead. Serialised as progress -- spelled out, because deriving it from the Perl name would produce Progress.

progress_detail

Undocumented upstream. The numbers behind "progress", which the swagger describes as a pre-formatted presentation of this field. Empty in all four events of t/fixtures/images_pull_stream.ndjson, which had nothing left to transfer. See API::Docker::Type::ProgressDetail. Serialised as progressDetail -- spelled out, because deriving it from the Perl name would produce ProgressDetail.

SUPPORT

Issues

Please report bugs and feature requests on GitHub at https://github.com/Getty/p5-api-docker/issues.

CONTRIBUTING

Contributions are welcome! Please fork the repository and submit a pull request.

AUTHOR

Torsten Raudssus <getty@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2026 by Torsten Raudssus <torsten@raudssus.de> https://raudssus.de/.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.