Module: Gitlab::Client::Runners
- Included in:
- Gitlab::Client
- Defined in:
- lib/gitlab/client/runners.rb
Overview
Defines methods related to runners.
Instance Method Summary collapse
-
#all_runners(options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Get a list of all runners in the GitLab instance (specific and shared).
-
#delete_runner(id) ⇒ Gitlab::ObjectifiedHash
Remove a runner.
-
#project_disable_runner(id, runner_id) ⇒ Gitlab::ObjectifiedHash
Disable a specific runner from the project.
-
#project_enable_runner(project_id, id) ⇒ Gitlab::ObjectifiedHash
Enable an available specific runner in the project.
-
#project_runners(project_id) ⇒ Array<Gitlab::ObjectifiedHash>
List all runners (specific and shared) available in the project.
-
#runner(id) ⇒ Gitlab::ObjectifiedHash
Get details of a runner..
-
#runner_jobs(runner_id) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of Jobs for a Runner.
-
#runners(options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Get a list of specific runners available to the user.
-
#update_runner(id, options = {}) ⇒ Gitlab::ObjectifiedHash
Update details of a runner.
Instance Method Details
#all_runners(options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Get a list of all runners in the GitLab instance (specific and shared). Access is restricted to users with admin privileges.
31 32 33 |
# File 'lib/gitlab/client/runners.rb', line 31 def all_runners( = {}) get('/runners/all', query: ) end |
#delete_runner(id) ⇒ Gitlab::ObjectifiedHash
Remove a runner.
72 73 74 |
# File 'lib/gitlab/client/runners.rb', line 72 def delete_runner(id) delete("/runners/#{id}") end |
#project_disable_runner(id, runner_id) ⇒ Gitlab::ObjectifiedHash
Disable a specific runner from the project. It works only if the project isn’t the only project associated with the specified runner.
122 123 124 |
# File 'lib/gitlab/client/runners.rb', line 122 def project_disable_runner(id, runner_id) delete("/projects/#{url_encode id}/runners/#{runner_id}") end |
#project_enable_runner(project_id, id) ⇒ Gitlab::ObjectifiedHash
Enable an available specific runner in the project.
108 109 110 111 |
# File 'lib/gitlab/client/runners.rb', line 108 def project_enable_runner(project_id, id) body = { runner_id: id } post("/projects/#{url_encode project_id}/runners", body: body) end |
#project_runners(project_id) ⇒ Array<Gitlab::ObjectifiedHash>
List all runners (specific and shared) available in the project. Shared runners are listed if at least one shared runner is defined and shared runners usage is enabled in the project’s settings.
95 96 97 |
# File 'lib/gitlab/client/runners.rb', line 95 def project_runners(project_id) get("/projects/#{url_encode project_id}/runners") end |
#runner(id) ⇒ Gitlab::ObjectifiedHash
Get details of a runner..
43 44 45 |
# File 'lib/gitlab/client/runners.rb', line 43 def runner(id) get("/runners/#{id}") end |
#runner_jobs(runner_id) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of Jobs for a Runner
83 84 85 |
# File 'lib/gitlab/client/runners.rb', line 83 def runner_jobs(runner_id) get("/runners/#{url_encode runner_id}/jobs") end |
#runners(options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Get a list of specific runners available to the user.
18 19 20 |
# File 'lib/gitlab/client/runners.rb', line 18 def runners( = {}) get('/runners', query: ) end |
#update_runner(id, options = {}) ⇒ Gitlab::ObjectifiedHash
Update details of a runner.
60 61 62 |
# File 'lib/gitlab/client/runners.rb', line 60 def update_runner(id, = {}) put("/runners/#{id}", query: ) end |