diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2018-05-29 09:08:52 +0200 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2018-05-29 09:08:52 +0200 |
| commit | 0be81cb8f48b7497a05ec7d1e7cf0a1b6eb045a1 (patch) | |
| tree | 57703ceac720467ecede42c9679d1286ff890b2a /docs/gl_objects | |
| parent | 096d9ecde6390a4d2795d0347280ccb2c1517143 (diff) | |
| download | gitlab-0be81cb8f48b7497a05ec7d1e7cf0a1b6eb045a1.tar.gz | |
Implement runner jobs listing
Diffstat (limited to 'docs/gl_objects')
| -rw-r--r-- | docs/gl_objects/runners.rst | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/gl_objects/runners.rst b/docs/gl_objects/runners.rst index 70bd60f..1e6f81b 100644 --- a/docs/gl_objects/runners.rst +++ b/docs/gl_objects/runners.rst @@ -94,3 +94,29 @@ Enable a specific runner for a project:: Disable a specific runner for a project:: project.runners.delete(runner.id) + +Runner jobs +=========== + +Reference +--------- + +* v4 API: + + + :class:`gitlab.v4.objects.RunnerJob` + + :class:`gitlab.v4.objects.RunnerJobManager` + + :attr:`gitlab.v4.objects.Runner.jobs` + +* GitLab API: https://docs.gitlab.com/ce/api/runners.html + +Examples +-------- + +List for jobs for a runner:: + + jobs = runner.jobs.list() + +Filter the list using the jobs status:: + + # status can be 'running', 'success', 'failed' or 'canceled' + active_jobs = runner.jobs.list(status='running') |