NAME

API::Docker::Type::Service - One entry of the 200 response to GET /services

VERSION

version 0.004

DESCRIPTION

Generated from the Service definition of spec/v1.51.yaml, which the swagger leaves undescribed. paths: says what it is: one entry of the 200 response to GET /services and the body of the 200 response to GET /services/{id}.

id

Undocumented upstream. The service's ID, 9mnpnzenvg8p8tdbtq4wvbkcz in the swagger's example -- the value that example's companion Task repeats as its ServiceID. Serialised as ID -- spelled out, because deriving it from the Perl name would produce Id.

version

The version number of the object such as node, service, etc. See API::Docker::Type::ObjectVersion.

created_at

Undocumented upstream. RFC 3339 with nanoseconds, 2016-06-07T21:05:51.880065305Z in the swagger's example.

updated_at

Undocumented upstream. The same format, and in that example some ninety-eight seconds later than "created_at".

spec

User modifiable configuration for a service. See API::Docker::Type::ServiceSpec.

endpoint

Undocumented upstream. The ports and virtual IPs the swarm actually gave the service. What was asked for is the EndpointSpec inside "spec", and the endpoint repeats it as its own Spec -- in the swagger's example all three copies of the port entry agree. See API::Docker::Type::Service::Endpoint.

update_status

The status of a service update. See API::Docker::Type::Service::UpdateStatus.

service_status

The status of the service's tasks. Provided only when requested as part of a ServiceList operation. See API::Docker::Type::Service::ServiceStatus.

job_status

The status of the service when it is in one of ReplicatedJob or GlobalJob modes. Absent on Replicated and Global mode services. The JobIteration is an ObjectVersion, but unlike the Service's version, does not need to be sent with an update request. See API::Docker::Type::Service::JobStatus.

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.