Module: Gitlab::CI::Client::Runners

Included in:
Gitlab::CI::Client
Defined in:
lib/gitlab/ci/client/runners.rb

Overview

Defines methods related to repositories.

See Also:

Instance Method Summary collapse

Instance Method Details

#delete_runner(token) ⇒ Array<Gitlab::ObjectifiedHash>

Used to remove runners.

Examples:

Gitlab::CI.delete_runner

Parameters:

  • options (Hash) —

    A customizable set of options.

Returns:

  • (Array<Gitlab::ObjectifiedHash>) 


40
41
42
 
# File 'lib/gitlab/ci/client/runners.rb', line 40

def delete_runner(token)
  delete("/runners/delete", body: { token: token })
end

#register_runner(token) ⇒ Array<Gitlab::ObjectifiedHash>

Used to make GitLab CI aware of available runners.

Examples:

Gitlab::CI.register_runner

Parameters:

  • options (Hash) —

    A customizable set of options.

Returns:

  • (Array<Gitlab::ObjectifiedHash>) 


28
29
30
 
# File 'lib/gitlab/ci/client/runners.rb', line 28

def register_runner(token)
  post("/runners/register", body: { token: token })
end

#runners(options = {}) ⇒ Array<Gitlab::ObjectifiedHash>

Used to get information about all runners registered on the GitLab CI instance.

Examples:

Gitlab::CI.runners

Parameters:

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Options Hash (options):

  • :page (Integer) —

    The page number.

  • :per_page (Integer) —

    The number of results per page.

Returns:

  • (Array<Gitlab::ObjectifiedHash>) 


14
15
16
 
# File 'lib/gitlab/ci/client/runners.rb', line 14

def runners(options={})
  get("/runners", query: options)
end