Runner¶
TODO
Runner API¶
-
class
gitlab_runner_api.
Runner
¶ -
classmethod
register
(api_url, token, description=None, active=None, locked=None, run_untagged=None, tags=None, maximum_timeout=None, name=None, version=None, revision=None, platform=None, architecture=None, executor=None, access_level=None)¶ Register a new runner in GitLab.
- api_url :
str
- URL for accessing the GitLab API
- token :
str
- Registration token
- description :
str
, optional - Runner’s description
- active :
str
, optional - Should Runner be active
- locked :
bool
, optional - Should Runner be locked for current project
- run_untagged :
bool
, optional - Should Runner handle untagged jobs
- tags :
list
ofstr
, optional - List of Runner’s tags
- maximum_timeout :
int
, optional - Maximum timeout set when this Runner will handle the job (in seconds)
- name :
str
, optional - The runner’s name
- version :
str
, optional - The runner’s version
- revision :
str
, optional - The runner’s revision
- platform :
str
, optional - The runner’s platform
- architecture :
str
, optional - The runner’s architecture
- executor :
str
, optional - The runner’s executor
- access_level :
str
, optional - Limit the jobs which will be sent to the runner (for security)
- api_url :
-
classmethod
load
(filename)¶ Serialise this runner as a file which can be loaded with Runner.load.
- filename :
str
- Path to file that represents the runner to initialise.
- filename :
-
classmethod
loads
(data)¶ Serialise this runner as a file which can be loaded with Runner.load.
- data :
str
- String representing the runner to initialise
- data :
-
dump
(filename)¶ Serialise this runner as a file which can be loaded with Runner.load
- filename :
str
- Registration token
- filename :
-
classmethod