NAME

API::Docker::Type::BuildInfo - One event of the stream a POST /build answers with

VERSION

version 0.004

DESCRIPTION

Generated from the BuildInfo definition of spec/v1.51.yaml, which the swagger leaves undescribed. Nothing references it and no path names it as a schema, because it is not a response body: POST /build answers 200 and then writes one of these objects per line until the daemon closes the connection. A failed build is still 200, and arrives as an event carrying errorDetail.

id

Undocumented upstream. The build stream captured in t/fixtures/images_build_stream.ndjson carries no id at all. The same field on a pull, "id" in API::Docker::Type::CreateImageInfo, names the layer each event is about. Serialised as id -- spelled out, because deriving it from the Perl name would produce Id.

stream

Undocumented upstream. The build log the way the daemon writes it, one line per event with the newline included -- {"stream":"STEP 1/2: FROM alpine:3\n"} opens t/fixtures/images_build_stream.ndjson. Nine of that capture's ten events are this field; the tenth is "aux". Serialised as stream -- spelled out, because deriving it from the Perl name would produce Stream.

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: t/fixtures/images_build_error_stream.ndjson ends with both, spelling "building at STEP \"RUN exit 7\": while running runtime: exit status 7" twice. See API::Docker::Type::ErrorDetail. Serialised as errorDetail -- spelled out, because deriving it from the Perl name would produce ErrorDetail.

status

Undocumented upstream. The same phase line a pull reports through "status" in API::Docker::Type::CreateImageInfo; the captured build stream carries "stream" instead and no status at all. 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. See API::Docker::Type::ProgressDetail. Serialised as progressDetail -- spelled out, because deriving it from the Perl name would produce ProgressDetail.

aux

Image ID or Digest. See API::Docker::Type::ImageID. Serialised as aux -- spelled out, because deriving it from the Perl name would produce Aux.

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.