docker_task_collection {stevedore}

Management commands for working with docker tasks

Description

Methods for working with docker tasks. This object is $task within a docker_client object.

Details

Below is reference documentation for all methods for version '1.29' of the docker API - other versions are available. This documentation is automatically generated from docker's API schema, and so inaccuracies may exist between it and stevedore's interface (especially references to JSON objects). Please report any documentation that might be improved at https://github.com/richfitz/stevedore/issues

Methods

get

Get a task by name or id

Usage:

  get(id)

Arguments:

• id: A scalar character with the network's name or id (abbreviations of the id are allowed and will be resolved by the docker daemon).

help

Display help for this object

Usage:

  help(help_type = getOption("help_type"))

Arguments:

• help_type: Passed to utils::help, can be one of "text", "html" or "pdf" (or an abbreviation). By default it uses the value getOption("help_type")and should follow the same behaviour as other R help (e.g., using "?")

task_list

List tasks

Usage:

  task_list(filters = NULL)

Arguments:

• filters: A named character vector of filters to process on the tasks list. Available filters:

  • desired-state=(running | shutdown | accepted)

  • id=<task id>

  • label=keyor label="key=value"

  • name=<task name>

  • node=<node id or name>

  • service=<service name>

See Also

docker_task for information on task objects.