API reference¶
-
class
api4jenkins.
Jenkins
(url, **kwargs)[source]¶ Constructs
Jenkins
.- Parameters
url – URL of Jenkins server,
str
auth – (optional) Auth
tuple
to enable Basic/Digest/Custom HTTP Auth.token – (optional) Boolean, Create user token when initialize instance and revoke token once instance is destroied. useful when LDAP server refuse username and password used too much often. Defaults to
False
.**kwargs – other kwargs are same as requests.Session.request
Usage:
>>> from api4jenkins import Jenkins >>> j = Jenkins('http://127.0.0.1:8080/', auth=('admin', 'admin')) >>> print(j) <Jenkins: http://127.0.0.1:8080/> >>> j.version '2.176.2'
-
api_json
(tree='', depth=0)¶
-
build_job
(full_name, **params)[source]¶ Build job with/without params
- Parameters
full_name –
str
, full name of jobparams – parameters for building, support delay and remote token
- Returns
QueueItem
Usage:
>>> from api4jenkins import Jenkins >>> j = Jenkins('http://127.0.0.1:8080/', auth=('admin', 'admin')) >>> item = j.build_job('freestylejob') >>> import time >>> while not item.get_build(): ... time.sleep(1) >>> build = item.get_build() >>> print(build) <FreeStyleBuild: http://127.0.0.1:8080/job/freestylejob/1/> >>> for line in build.progressive_output(): ... print(line) ...
-
copy_job
(full_name, dest)[source]¶ Create job by copying other job, the source job and dest job are in same folder.
- Parameters
full_name – full name of source job
dest – name of new job
Usage:
>>> from api4jenkins import Jenkins >>> j = Jenkins('http://127.0.0.1:8080/', auth=('admin', 'admin')) >>> j.copy_job('folder/freestylejob', 'newjob') >>> j.get_job('folder/newjob') >>> print(job) <FreeStyleProject: http://127.0.0.1:8080/job/folder/job/newjob/>
-
create_job
(full_name, xml)[source]¶ Create new jenkins job with given xml configuration
- Parameters
full_name –
str
, full name of jobxml – xml configuration string
Usage:
>>> from api4jenkins import Jenkins >>> j = Jenkins('http://127.0.0.1:8080/', auth=('admin', 'admin')) >>> xml = """<?xml version='1.1' encoding='UTF-8'?> ... <project> ... <builders> ... <hudson.tasks.Shell> ... <command>echo $JENKINS_VERSION</command> ... </hudson.tasks.Shell> ... </builders> ... </project>""" >>> j.create_job('freestylejob', xml) >>> job = j.get_job('freestylejob') >>> print(job) <FreeStyleProject: http://127.0.0.1:8080/job/freestylejob/>
-
property
credentials
¶ An object for managing credentials. see
Credentials
-
property
crumb
¶ Crumb of Jenkins
-
delete_job
(full_name)[source]¶ Delete job
- Parameters
full_name –
str
, full name of job
Usage:
>>> from api4jenkins import Jenkins >>> j = Jenkins('http://127.0.0.1:8080/', auth=('admin', 'admin')) >>> job = j.get_job('freestylejob') >>> print(job) <FreeStyleProject: http://127.0.0.1:8080/job/freestylejob/> >>> j.delete_job('freestylejob') >>> job = j.get_job('freestylejob') >>> print(job) None
-
property
dynamic_attrs
¶
-
get_job
(full_name)[source]¶ Get job by full name
- Parameters
full_name –
str
, full name of job- Returns
Corresponding Job object or None
Usage:
>>> from api4jenkins import Jenkins >>> j = Jenkins('http://127.0.0.1:8080/', auth=('admin', 'admin')) >>> job = j.get_job('freestylejob') >>> print(job) <FreeStyleProject: http://127.0.0.1:8080/job/freestylejob/>
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
iter_jobs
(depth=0)[source]¶ Iterate jobs with depth
- Parameters
depth –
int
, depth to iterate, default is 0- Returns
iterator of jobs
Usage:
>>> from api4jenkins import Jenkins >>> j = Jenkins('http://127.0.0.1:8080/', auth=('admin', 'admin')) >>> for job in j.iter_jobs(): ... print(job) <FreeStyleProject: http://127.0.0.1:8080/job/freestylejob/> ...
-
property
me
¶
-
property
plugins
¶ An object for managing plugins. see
PluginsManager
-
property
users
¶
-
property
version
¶ Version of Jenkins
-
class
api4jenkins.job.
ExternalJob
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
build
(**params)¶
-
property
building
¶
-
configure
(xml=None)¶
-
delete
()¶
-
disable
()¶
-
duplicate
(path)¶
-
property
dynamic_attrs
¶
-
enable
()¶
-
exists
()¶
-
get_build
(number)¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
iter_builds
()¶
-
move
(path)¶
-
property
parent
¶
-
rename
(name)¶
-
set_description
(text)¶
-
set_next_build_number
(number)¶
-
-
class
api4jenkins.job.
Folder
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
configure
(xml=None)¶
-
property
credentials
¶
-
delete
()¶
-
duplicate
(path)¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
move
(path)¶
-
property
parent
¶
-
rename
(name)¶
-
set_description
(text)¶
-
property
views
¶
-
-
class
api4jenkins.job.
FreeStyleProject
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
build
(**params)¶
-
property
building
¶
-
configure
(xml=None)¶
-
delete
()¶
-
disable
()¶
-
duplicate
(path)¶
-
property
dynamic_attrs
¶
-
enable
()¶
-
exists
()¶
-
get_build
(number)¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
iter_builds
()¶
-
move
(path)¶
-
property
parent
¶
-
rename
(name)¶
-
set_description
(text)¶
-
set_next_build_number
(number)¶
-
-
class
api4jenkins.job.
IvyModuleSet
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
build
(**params)¶
-
property
building
¶
-
configure
(xml=None)¶
-
delete
()¶
-
disable
()¶
-
duplicate
(path)¶
-
property
dynamic_attrs
¶
-
enable
()¶
-
exists
()¶
-
get_build
(number)¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
iter_builds
()¶
-
move
(path)¶
-
property
parent
¶
-
rename
(name)¶
-
set_description
(text)¶
-
set_next_build_number
(number)¶
-
-
class
api4jenkins.job.
Job
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
configure
(xml=None)¶
-
delete
()¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
property
parent
¶
-
set_description
(text)¶
-
-
class
api4jenkins.job.
MatrixProject
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
build
(**params)¶
-
property
building
¶
-
configure
(xml=None)¶
-
delete
()¶
-
disable
()¶
-
duplicate
(path)¶
-
property
dynamic_attrs
¶
-
enable
()¶
-
exists
()¶
-
get_build
(number)¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
iter_builds
()¶
-
move
(path)¶
-
property
parent
¶
-
rename
(name)¶
-
set_description
(text)¶
-
set_next_build_number
(number)¶
-
-
class
api4jenkins.job.
MavenModuleSet
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
build
(**params)¶
-
property
building
¶
-
configure
(xml=None)¶
-
delete
()¶
-
disable
()¶
-
duplicate
(path)¶
-
property
dynamic_attrs
¶
-
enable
()¶
-
exists
()¶
-
get_build
(number)¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
iter_builds
()¶
-
move
(path)¶
-
property
parent
¶
-
rename
(name)¶
-
set_description
(text)¶
-
set_next_build_number
(number)¶
-
-
class
api4jenkins.job.
MultiJobProject
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
build
(**params)¶
-
property
building
¶
-
configure
(xml=None)¶
-
delete
()¶
-
disable
()¶
-
duplicate
(path)¶
-
property
dynamic_attrs
¶
-
enable
()¶
-
exists
()¶
-
get_build
(number)¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
iter_builds
()¶
-
move
(path)¶
-
property
parent
¶
-
rename
(name)¶
-
set_description
(text)¶
-
set_next_build_number
(number)¶
-
-
class
api4jenkins.job.
Project
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
property
building
¶
-
configure
(xml=None)¶
-
delete
()¶
-
disable
()¶
-
duplicate
(path)¶
-
property
dynamic_attrs
¶
-
enable
()¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
move
(path)¶
-
property
parent
¶
-
rename
(name)¶
-
set_description
(text)¶
-
-
class
api4jenkins.job.
WorkflowJob
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
build
(**params)¶
-
property
building
¶
-
configure
(xml=None)¶
-
delete
()¶
-
disable
()¶
-
duplicate
(path)¶
-
property
dynamic_attrs
¶
-
enable
()¶
-
exists
()¶
-
get_build
(number)¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
iter_builds
()¶
-
move
(path)¶
-
property
parent
¶
-
rename
(name)¶
-
set_description
(text)¶
-
set_next_build_number
(number)¶
-
-
class
api4jenkins.job.
WorkflowMultiBranchProject
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
configure
(xml=None)¶
-
copy
(src, dest)¶
-
create
(name, xml)¶
-
property
credentials
¶
-
delete
()¶
-
disable
()¶
-
duplicate
(path)¶
-
property
dynamic_attrs
¶
-
enable
()¶
-
exists
()¶
-
get
(name)¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
iter
(depth=0)¶
-
move
(path)¶
-
property
parent
¶
-
reload
()¶
-
rename
(name)¶
-
set_description
(text)¶
-
property
views
¶
-
-
class
api4jenkins.build.
Build
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
delete
()¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
set_description
(text)¶
-
-
class
api4jenkins.build.
FreeStyleBuild
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
console_text
(stream=False)¶
-
delete
()¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
get_job
()¶ get job of this build
-
get_next_build
()¶
-
get_previous_build
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
kill
()¶
-
progressive_output
(html=False)¶
-
set_description
(text)¶
-
stop
()¶
-
term
()¶
-
-
class
api4jenkins.build.
MatrixBuild
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
console_text
(stream=False)¶
-
delete
()¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
get_job
()¶ get job of this build
-
get_next_build
()¶
-
get_previous_build
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
kill
()¶
-
progressive_output
(html=False)¶
-
set_description
(text)¶
-
stop
()¶
-
term
()¶
-
-
class
api4jenkins.build.
WorkflowRun
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
console_text
(stream=False)¶
-
delete
()¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
get_job
()¶ get job of this build
-
get_next_build
()¶
-
get_previous_build
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
kill
()¶
-
progressive_output
(html=False)¶
-
set_description
(text)¶
-
stop
()¶
-
term
()¶
-
-
class
api4jenkins.input.
PendingInputAction
(jenkins, raw)[source]¶ this class implement functionality to process input step
-
abort
()[source]¶ submit input step
-
api_json
(tree='', depth=0)¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
submit
(**params)[source]¶ submit input step
- for input requires parametes:
if submit without parameters, it will use default value of parameters
if submit with wrong parameters, exception raised
for input does not requires parameters, but submit with paramters, exception raised
-
-
class
api4jenkins.queue.
BlockedItem
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
cancel
()¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
get_build
()¶
-
get_job
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
-
class
api4jenkins.queue.
BuildableItem
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
cancel
()¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
get_build
()¶
-
get_job
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
-
class
api4jenkins.queue.
LeftItem
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
cancel
()¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
get_build
()¶
-
get_job
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
-
class
api4jenkins.queue.
Queue
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
-
class
api4jenkins.queue.
QueueItem
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
-
class
api4jenkins.queue.
WaitingItem
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
cancel
()¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
get_build
()¶
-
get_job
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
-
class
api4jenkins.credential.
Credential
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
configure
(xml=None)¶
-
delete
()¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
-
class
api4jenkins.credential.
Credentials
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
-
class
api4jenkins.node.
DockerComputer
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
configure
(xml=None)¶
-
delete
()¶
-
disable
(msg='')¶
-
property
dynamic_attrs
¶
-
enable
()¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
iter_builds
()¶
-
run_script
(script)¶
-
-
class
api4jenkins.node.
KubernetesComputer
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
configure
(xml=None)¶
-
delete
()¶
-
disable
(msg='')¶
-
property
dynamic_attrs
¶
-
enable
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
iter_builds
()¶
-
run_script
(script)¶
-
-
class
api4jenkins.node.
MasterComputer
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
configure
(xml=None)¶
-
delete
()¶
-
disable
(msg='')¶
-
property
dynamic_attrs
¶
-
enable
()¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
iter_builds
()¶
-
run_script
(script)¶
-
-
class
api4jenkins.node.
Node
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
configure
(xml=None)¶
-
delete
()¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
run_script
(script)¶
-
-
class
api4jenkins.node.
Nodes
(jenkins, url)[source]¶ classdocs
-
api_json
(tree='', depth=0)¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
-
class
api4jenkins.node.
SlaveComputer
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
configure
(xml=None)¶
-
delete
()¶
-
disable
(msg='')¶
-
property
dynamic_attrs
¶
-
enable
()¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
iter_builds
()¶
-
run_script
(script)¶
-
-
class
api4jenkins.plugin.
Plugin
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
-
class
api4jenkins.plugin.
PluginsManager
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
property
installation_done
¶
-
property
restart_required
¶
-
property
site
¶
-
property
update_center
¶
-
-
class
api4jenkins.plugin.
UpdateCenter
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
property
installation_done
¶
-
property
restart_required
¶
-
property
site
¶
-
-
class
api4jenkins.view.
AllView
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
configure
(xml=None)¶
-
delete
()¶
-
property
dynamic_attrs
¶
-
exclude
(name)¶
-
exists
()¶
-
get_job
(name)¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
include
(name)¶
-
set_description
(text)¶
-
-
class
api4jenkins.view.
ListView
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
configure
(xml=None)¶
-
delete
()¶
-
property
dynamic_attrs
¶
-
exclude
(name)¶
-
exists
()¶
-
get_job
(name)¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
include
(name)¶
-
set_description
(text)¶
-
-
class
api4jenkins.view.
MyView
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
configure
(xml=None)¶
-
delete
()¶
-
property
dynamic_attrs
¶
-
exclude
(name)¶
-
exists
()¶
-
get_job
(name)¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
include
(name)¶
-
set_description
(text)¶
-
-
class
api4jenkins.view.
View
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
configure
(xml=None)¶
-
delete
()¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
set_description
(text)¶
-
-
class
api4jenkins.view.
Views
(owner)[source]¶ classdocs
-
api_json
(tree='', depth=0)¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
-
class
api4jenkins.system.
System
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
run_script
(script)¶
-
-
class
api4jenkins.user.
ApiToken
(name, uuid, value)¶ -
count
(value, /)¶ Return number of occurrences of value.
-
index
(value, start=0, stop=9223372036854775807, /)¶ Return first index of value.
Raises ValueError if the value is not present.
-
property
name
¶ Alias for field number 0
-
property
uuid
¶ Alias for field number 1
-
property
value
¶ Alias for field number 2
-
-
class
api4jenkins.user.
User
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
delete
()¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
set_description
(text)¶
-
-
class
api4jenkins.user.
Users
(jenkins, url)[source]¶ -
api_json
(tree='', depth=0)¶
-
property
dynamic_attrs
¶
-
exists
()¶
-
handle_req
(method, entry, **kwargs)¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
tree
= 'users[user[id,absoluteUrl,fullName]]'¶
-
-
class
api4jenkins.item.
Item
(jenkins, url)[source]¶ classdocs
-
property
dynamic_attrs
¶
-
headers
= {'Content-Type': 'text/xml; charset=utf-8'}¶
-
property
-
api4jenkins.item.
new_item
(jenkins, module, item)¶
-
api4jenkins.item.
snake
(name)¶
-
exception
api4jenkins.exceptions.
AuthenticationError
[source]¶ -
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
api4jenkins.exceptions.
BadRequestError
[source]¶ -
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
api4jenkins.exceptions.
ItemExistsError
[source]¶ -
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
api4jenkins.exceptions.
ItemNotFoundError
[source]¶ -
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-