Module Reference

• User API
  • block_until_complete()
  • get_artifacts()
  • get_build()
  • get_latest_build()
  • get_latest_complete_build()
  • get_latest_test_results()
  • get_nested_view_from_url()
  • get_view_from_url()
  • grab_artifact()
  • install_artifacts()
  • search_artifact_by_regexp()
  • search_artifacts()
• Artifact
  • Artifact
    • Artifact.get_data()
    • Artifact.get_jenkins_obj()
    • Artifact.save()
    • Artifact.save_to_dir()
• Build
  • Build
    • Build.STR_TOTALCOUNT
    • Build.STR_TPL_NOTESTS_ERR
    • Build.block()
    • Build.block_until_complete()
    • Build.get_actions()
    • Build.get_artifact_dict()
    • Build.get_artifacts()
    • Build.get_build_url()
    • Build.get_causes()
    • Build.get_changeset_items()
    • Build.get_console()
    • Build.get_description()
    • Build.get_downstream_builds()
    • Build.get_downstream_job_names()
    • Build.get_downstream_jobs()
    • Build.get_duration()
    • Build.get_env_vars()
    • Build.get_estimated_duration()
    • Build.get_jenkins_obj()
    • Build.get_master_build()
    • Build.get_master_build_number()
    • Build.get_master_job()
    • Build.get_master_job_name()
    • Build.get_matrix_runs()
    • Build.get_number()
    • Build.get_params()
    • Build.get_repo_url()
    • Build.get_result_url()
    • Build.get_resultset()
    • Build.get_revision()
    • Build.get_revision_branch()
    • Build.get_slave()
    • Build.get_status()
    • Build.get_timestamp()
    • Build.get_upstream_build()
    • Build.get_upstream_build_number()
    • Build.get_upstream_job()
    • Build.get_upstream_job_name()
    • Build.has_resultset()
    • Build.is_good()
    • Build.is_kept_forever()
    • Build.is_running()
    • Build.name
    • Build.stop()
    • Build.stream_logs()
    • Build.toggle_keep()
• Credentials and Credential
  • Credentials
    • Credentials
      • Credentials.get()
      • Credentials.get_jenkins_obj()
      • Credentials.iteritems()
      • Credentials.iterkeys()
      • Credentials.keys()
    • Credentials2x
    • CredentialsById
      • CredentialsById.iteritems()
  • Credential
    • AmazonWebServicesCredentials
      • AmazonWebServicesCredentials.get_attributes()
      • AmazonWebServicesCredentials.get_attributes_xml()
    • Credential
      • Credential.get_attributes()
      • Credential.get_attributes_xml()
    • SSHKeyCredential
      • SSHKeyCredential.attrs
      • SSHKeyCredential.get_attributes()
      • SSHKeyCredential.get_attributes_xml()
    • SecretTextCredential
      • SecretTextCredential.get_attributes()
      • SecretTextCredential.get_attributes_xml()
    • UsernamePasswordCredential
      • UsernamePasswordCredential.get_attributes()
      • UsernamePasswordCredential.get_attributes_xml()
• Custom_exceptions
  • AlreadyExists
  • ArtifactBroken
  • ArtifactsMissing
  • BadParams
  • BadURL
  • FailedNoResults
  • JenkinsAPIException
  • NoBuildData
  • NoResults
  • NotAuthorized
  • NotBuiltYet
  • NotConfiguredSCM
  • NotFound
  • NotInQueue
  • NotSupportSCM
  • PostRequired
  • TimeOut
  • UnknownJob
  • UnknownNode
  • UnknownPlugin
  • UnknownQueueItem
  • UnknownView
• Command_line
  • Command_line.jenkins_invoke module
    • JenkinsInvoke
      • JenkinsInvoke.invokejob()
      • JenkinsInvoke.main()
      • JenkinsInvoke.mkparser()
    • main()
• Exectors and Executor
  • Executors
    • Executors
      • Executors.get_jenkins_obj()
  • Executor
    • Executor
      • Executor.get_current_executable()
      • Executor.get_jenkins_obj()
      • Executor.get_number()
      • Executor.get_progress()
      • Executor.is_idle()
      • Executor.likely_stuck()
• Fingerprint
  • Fingerprint
    • Fingerprint.RE_MD5
    • Fingerprint.get_info()
    • Fingerprint.get_jenkins_obj()
    • Fingerprint.valid()
    • Fingerprint.validate()
    • Fingerprint.validate_for_build()
• Jenkins
  • Jenkins
    • Jenkins.base_server_url()
    • Jenkins.build_job()
    • Jenkins.cancel_quiet_down()
    • Jenkins.copy_job()
    • Jenkins.create_job()
    • Jenkins.create_multibranch_pipeline_job()
    • Jenkins.create_node()
    • Jenkins.create_node_with_config()
    • Jenkins.credentials
    • Jenkins.credentials_by_id
    • Jenkins.delete_job()
    • Jenkins.delete_node()
    • Jenkins.delete_plugin()
    • Jenkins.delete_plugins()
    • Jenkins.delete_view_by_url()
    • Jenkins.generate_new_api_token()
    • Jenkins.get_artifact_data()
    • Jenkins.get_create_url()
    • Jenkins.get_credentials()
    • Jenkins.get_executors()
    • Jenkins.get_jenkins_obj()
    • Jenkins.get_jenkins_obj_from_url()
    • Jenkins.get_job()
    • Jenkins.get_job_by_url()
    • Jenkins.get_jobs()
    • Jenkins.get_jobs_info()
    • Jenkins.get_jobs_list()
    • Jenkins.get_label()
    • Jenkins.get_master_data()
    • Jenkins.get_node()
    • Jenkins.get_node_url()
    • Jenkins.get_nodes()
    • Jenkins.get_nodes_url()
    • Jenkins.get_plugins()
    • Jenkins.get_plugins_url()
    • Jenkins.get_queue()
    • Jenkins.get_queue_url()
    • Jenkins.get_view_by_url()
    • Jenkins.has_job()
    • Jenkins.has_node()
    • Jenkins.has_plugin()
    • Jenkins.install_plugin()
    • Jenkins.install_plugins()
    • Jenkins.is_quieting_down
    • Jenkins.items()
    • Jenkins.iteritems()
    • Jenkins.iterkeys()
    • Jenkins.jobs
    • Jenkins.keys()
    • Jenkins.nodes
    • Jenkins.plugins
    • Jenkins.quiet_down()
    • Jenkins.rename_job()
    • Jenkins.run_groovy_script()
    • Jenkins.safe_exit()
    • Jenkins.safe_restart()
    • Jenkins.shutdown()
    • Jenkins.use_auth_cookie()
    • Jenkins.validate_fingerprint()
    • Jenkins.validate_fingerprint_for_build()
    • Jenkins.version
    • Jenkins.views
• Jenkinsbase
  • JenkinsBase
    • JenkinsBase.get_data()
    • JenkinsBase.get_jenkins_obj()
    • JenkinsBase.poll()
    • JenkinsBase.pprint()
    • JenkinsBase.process_job_folder()
    • JenkinsBase.python_api_url()
    • JenkinsBase.resolve_job_folders()
    • JenkinsBase.strip_trailing_slash()
• Jobs and job
  • Jobs
    • Jobs
      • Jobs.build()
      • Jobs.copy()
      • Jobs.create()
      • Jobs.create_multibranch_pipeline()
      • Jobs.iteritems()
      • Jobs.iterkeys()
      • Jobs.itervalues()
      • Jobs.keys()
      • Jobs.poll()
      • Jobs.rename()
  • Job
    • Job
      • Job.delete_build()
      • Job.delete_from_queue()
      • Job.disable()
      • Job.enable()
      • Job.get_build()
      • Job.get_build_by_params()
      • Job.get_build_dict()
      • Job.get_build_ids()
      • Job.get_build_metadata()
      • Job.get_build_triggerurl()
      • Job.get_buildnumber_for_revision()
      • Job.get_config()
      • Job.get_config_xml_url()
      • Job.get_description()
      • Job.get_downstream_job_names()
      • Job.get_downstream_jobs()
      • Job.get_first_build()
      • Job.get_first_buildnumber()
      • Job.get_full_name()
      • Job.get_full_name_from_url_and_baseurl()
      • Job.get_jenkins_obj()
      • Job.get_last_build()
      • Job.get_last_build_or_none()
      • Job.get_last_buildnumber()
      • Job.get_last_completed_build()
      • Job.get_last_completed_buildnumber()
      • Job.get_last_failed_buildnumber()
      • Job.get_last_good_build()
      • Job.get_last_good_buildnumber()
      • Job.get_last_stable_build()
      • Job.get_last_stable_buildnumber()
      • Job.get_next_build_number()
      • Job.get_params()
      • Job.get_params_list()
      • Job.get_queue_item()
      • Job.get_revision_dict()
      • Job.get_scm_branch()
      • Job.get_scm_type()
      • Job.get_scm_url()
      • Job.get_upstream_job_names()
      • Job.get_upstream_jobs()
      • Job.has_params()
      • Job.has_queued_build()
      • Job.invoke()
      • Job.is_enabled()
      • Job.is_queued()
      • Job.is_queued_or_running()
      • Job.is_running()
      • Job.load_config()
      • Job.mk_json_from_build_parameters()
      • Job.modify_scm_branch()
      • Job.modify_scm_url()
      • Job.poll()
      • Job.toggle_keep_build()
      • Job.update_config()
• Label
  • Label
    • Label.get_jenkins_obj()
    • Label.get_tied_job_names()
    • Label.get_tied_jobs()
    • Label.is_online()
• Mutable_jenkins_thing
  • MutableJenkinsThing
    • MutableJenkinsThing.get_delete_url()
    • MutableJenkinsThing.get_rename_url()
• Nodes and node
  • nodes
    • Nodes
      • Nodes.create_node()
      • Nodes.create_node_with_config()
      • Nodes.get_jenkins_obj()
      • Nodes.items()
      • Nodes.iteritems()
      • Nodes.iterkeys()
      • Nodes.itervalues()
      • Nodes.keys()
      • Nodes.values()
  • node
    • Node
      • Node.block_until_idle()
      • Node.get_architecture()
      • Node.get_available_physical_memory()
      • Node.get_available_swap_space()
      • Node.get_clock_difference()
      • Node.get_config()
      • Node.get_config_element()
      • Node.get_jenkins_obj()
      • Node.get_labels()
      • Node.get_monitor()
      • Node.get_node_attributes()
      • Node.get_num_executors()
      • Node.get_response_time()
      • Node.get_temp_path()
      • Node.get_temp_size()
      • Node.get_total_physical_memory()
      • Node.get_total_swap_space()
      • Node.get_workspace_path()
      • Node.get_workspace_size()
      • Node.is_idle()
      • Node.is_jnlpagent()
      • Node.is_online()
      • Node.is_temporarily_offline()
      • Node.launch()
      • Node.load_config()
      • Node.offline_reason()
      • Node.set_config_element()
      • Node.set_num_executors()
      • Node.set_offline()
      • Node.set_online()
      • Node.toggle_temporarily_offline()
      • Node.update_offline_reason()
      • Node.upload_config()
• Plugins and Plugin
  • Plugins
    • Plugins
      • Plugins.check_updates_server()
      • Plugins.get_jenkins_obj()
      • Plugins.get_plugins_dict()
      • Plugins.iteritems()
      • Plugins.keys()
      • Plugins.plugin_version_already_installed()
      • Plugins.plugin_version_is_being_installed()
      • Plugins.restart_required
      • Plugins.update_center_dict
      • Plugins.update_center_install_status
      • Plugins.values()
  • Plugin
    • Plugin
      • Plugin.get_attributes()
      • Plugin.get_download_link()
      • Plugin.is_latest()
      • Plugin.to_plugin()
• Utils
  • crumb_requester module
    • CrumbRequester
      • CrumbRequester.post_url()
  • jenkins_launcher module
    • FailedToStart
    • JenkinsLancher
      • JenkinsLancher.JENKINS_LTS_WAR_URL
      • JenkinsLancher.JENKINS_WEEKLY_WAR_URL
      • JenkinsLancher.block_until_jenkins_ready()
      • JenkinsLancher.install_plugin()
      • JenkinsLancher.install_plugins()
      • JenkinsLancher.start()
      • JenkinsLancher.stop()
      • JenkinsLancher.update_config()
      • JenkinsLancher.update_war()
    • StreamThread
      • StreamThread.run()
      • StreamThread.stop()
      • StreamThread.stopped()
    • TimeOut
  • jsonp_to_json module
    • jsonp_to_json()
  • krb_requester module
    • KrbRequester
      • KrbRequester.get_request_dict()
  • manifest module
    • InvalidJarError
    • Manifest
    • read_manifest()
  • requester module
    • Requester
      • Requester.AUTH_COOKIE
      • Requester.VALID_STATUS_CODES
      • Requester.get_and_confirm_status()
      • Requester.get_request_dict()
      • Requester.get_url()
      • Requester.post_and_confirm_status()
      • Requester.post_url()
      • Requester.post_xml_and_confirm_status()
  • simple_post_logger module
    • ServerHandler
      • ServerHandler.do_GET()
      • ServerHandler.do_POST()
  • Module contents
• Queue
  • Queue
    • Queue.delete_item()
    • Queue.delete_item_by_id()
    • Queue.get_jenkins_obj()
    • Queue.get_queue_item_url()
    • Queue.get_queue_items_for_job()
    • Queue.iteritems()
    • Queue.iterkeys()
    • Queue.itervalues()
    • Queue.keys()
    • Queue.values()
  • QueueItem
    • QueueItem.block_until_building()
    • QueueItem.block_until_complete()
    • QueueItem.get_build()
    • QueueItem.get_build_number()
    • QueueItem.get_jenkins_obj()
    • QueueItem.get_job()
    • QueueItem.get_job_name()
    • QueueItem.get_parameters()
    • QueueItem.is_queued()
    • QueueItem.is_running()
    • QueueItem.name
    • QueueItem.queue_id
    • QueueItem.why
• Result_set and result
  • Result
    • Result
      • Result.identifier()
  • Result_set
    • ResultSet
      • ResultSet.get_jenkins_obj()
      • ResultSet.items()
      • ResultSet.iteritems()
      • ResultSet.keys()
      • ResultSet.name
• View and Views
  • Views
    • Views
      • Views.CATEGORIZED_VIEW
      • Views.DASHBOARD_VIEW
      • Views.LIST_VIEW
      • Views.MY_VIEW
      • Views.NESTED_VIEW
      • Views.PIPELINE_VIEW
      • Views.create()
      • Views.iteritems()
      • Views.iterkeys()
      • Views.keys()
      • Views.poll()
  • View
    • View
      • View.add_job()
      • View.delete()
      • View.get_config()
      • View.get_config_xml_url()
      • View.get_jenkins_obj()
      • View.get_job_dict()
      • View.get_job_url()
      • View.get_nested_view_dict()
      • View.items()
      • View.iteritems()
      • View.keys()
      • View.remove_job()
      • View.update_config()
      • View.values()
      • View.views