NAME
API::Docker::Type::Task - One entry of the 200 response to GET /tasks
VERSION
version 0.004
DESCRIPTION
Generated from the Task definition of spec/v1.51.yaml, which the swagger leaves undescribed. paths: says what it is: one entry of the 200 response to GET /tasks and the body of the 200 response to GET /tasks/{id}.
id
The ID of the task. 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:07:31.171892745Z in the swagger's example.
updated_at
Undocumented upstream. The same format, two hundred milliseconds later in that example -- the task was created and then reported running.
name
Name of the task.
labels
User-defined key/value metadata. The keys are the caller's data and are never translated.
spec
User modifiable task configuration. See API::Docker::Type::TaskSpec.
service_id
The ID of the service this task is part of. Serialised as ServiceID -- spelled out, because deriving it from the Perl name would produce ServiceId.
slot
Undocumented upstream. 1 in the swagger's example, whose ServiceID is the same 9mnpnzenvg8p8tdbtq4wvbkcz the Service example carries, and that service asks for one replica. Read it as which replica of the service this task is.
node_id
The ID of the node that this task is on. Serialised as NodeID -- spelled out, because deriving it from the Perl name would produce NodeId.
assigned_generic_resources
User-defined resources can be either Integer resources (e.g, SSD=3) or String resources (e.g, GPU=UUID1). See API::Docker::Type::GenericResource.
status
Represents the status of a task. See API::Docker::Type::TaskStatus.
desired_state
Undocumented upstream. Where the orchestrator wants the task, against "state" in API::Docker::Type::TaskStatus which is where it actually is. Both are running in the swagger's example. The swagger enumerates new, allocated, pending, assigned, accepted, preparing, ready, starting, running, complete, shutdown, failed, rejected, remove and orphaned.
job_iteration
If the Service this Task belongs to is a job-mode service, contains the JobIteration of the Service this Task was created for. Absent if the Task was created for a Replicated or Global Service. See API::Docker::Type::ObjectVersion.
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.