summaryrefslogtreecommitdiff
path: root/docs/gl_objects/runners.rst
blob: 32d67199958d3f9f22bf3afc7c780376f2c476dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
#######
Runners
#######

Global runners
==============

Use :class:`~gitlab.objects.Runner` objects to manipulate runners. The
:attr:`gitlab.Gitlab.runners` manager object provides helper functions.

Examples
--------

Use the ``list()`` and ``all()`` methods to list runners.

The ``all()`` method accepts a ``scope`` parameter to filter the list. Allowed
values for this parameter are ``specific``, ``shared``, ``active``, ``paused``
and ``online``.

.. note::

   The returned objects hold minimal information about the runners. Use the
   ``get()`` method to retrieve detail about a runner.

.. literalinclude:: runners.py
   :start-after: # list
   :end-before: # end list

Get a runner's detail:

.. literalinclude:: runners.py
   :start-after: # get
   :end-before: # end get

Update a runner:

.. literalinclude:: runners.py
   :start-after: # update
   :end-before: # end update

Remove a runner:

.. literalinclude:: runners.py
   :start-after: # delete
   :end-before: # end delete