Views

Search for a view

views.Views.search()

Search for a view within Jenkins.

Parameters:: view_path (str) – The path of the view to search for.
Returns:: The View object representing the found view.
Return type:: jenkins_pysdk.views.View
Raises:: JenkinsNotFound – If the view was not found.

from jenkins_pysdk.jenkins import Jenkins
jenkins = Jenkins(host="JenkinsDNS", username="admin", token="11e8e294cee85ee88b60d99328284d7608")
print(jenkins.views.search("All"))

The above code will output:

<jenkins_pysdk.views.View object at 0x0000026497A93820>

Iterate all views

views.Views.iter()

Iterate through views.

Parameters:

folder (str, optional) – Check if folder is in a view. Default is None.
_paginate (int, optional) – Pagination option. Default is 0 (no pagination).

Returns:

A generator yielding View objects.

Return type:

Generator[jenkins_pysdk.views.View]

from jenkins_pysdk.jenkins import Jenkins
jenkins = Jenkins(host="JenkinsDNS", username="admin", token="11e8e294cee85ee88b60d99328284d7608")
for view in jenkins.views.iter():
    print(view.name)

The above code will output:

all
m
my

List all views

views.Views.list()

List all views.

Parameters:

folder (str, optional) – Folder to iterate through. Default is None.
_paginate (int, optional) – Pagination option. Default is 0 (no pagination).

Returns:

A list of View objects.

Return type:

List[jenkins_pysdk.views.View]

from jenkins_pysdk.jenkins import Jenkins
jenkins = Jenkins(host="JenkinsDNS", username="admin", token="11e8e294cee85ee88b60d99328284d7608")
print(jenkins.views.list())

The above code will output:

[<jenkins_pysdk.views.View object at 0x0000013439AA9E10>, <jenkins_pysdk.views.View object at 0x0000013439AA9DE0>, <jenkins_pysdk.views.View object at 0x0000013439AA9DB0>]

Create a view

views.Views.create()

Create a new view.

Parameters:

name (str) – The name of the new view.
xml (str or Builder.View) – The XML configuration or Builder.View object for the new view.

Returns:

JenkinsActionObject indicating the result of the creation.

Return type:

jenkins_pysdk.objects.JenkinsActionObject

Raises:

JenkinsGeneralException – If a general exception occurs.

from jenkins_pysdk.jenkins import Jenkins
jenkins = Jenkins(host="JenkinsDNS", username="admin", token="11e8e294cee85ee88b60d99328284d7608")
xml = """
   <hudson.model.ListView>
     <name>my_view</name>
     <mode>hudson.model.ListView</mode>
     <description>Your view description</description>
     <jobNames>
       <comparator class="hudson.util.CaseInsensitiveComparator"/>
       <string>new_freestyle</string>
     </jobNames>
     <columns>
       <hudson.views.StatusColumn/>
       <hudson.views.WeatherColumn/>
       <hudson.views.JobColumn/>
     </columns>
     <recurse>true</recurse>
   </hudson.model.ListView>
   """
print(jenkins.views.create("my_view", xml))

The above code will output:

request=<Request object at 2275566295520> content='[200] Successfully created my_view.' status_code=200

View

Get the view name

views.View.name()

Get the name of the view.

Returns:: The name of the view.
Return type:: str

from jenkins_pysdk.jenkins import Jenkins
jenkins = Jenkins(host="JenkinsDNS", username="admin", token="11e8e294cee85ee88b60d99328284d7608")
print(jenkins.views.search("All").name)

The above code will output:

All

Get the view URL

views.View.url()

Get the URL of the view.

Returns:: The URL of the view.
Return type:: str

from jenkins_pysdk.jenkins import Jenkins
jenkins = Jenkins(host="JenkinsDNS", username="admin", token="11e8e294cee85ee88b60d99328284d7608")
print(jenkins.views.search("All").url)

The above code will output:

http://JenkinsDNS/view/All

Reconfigure the view (Job order must be the same as the order in the application, otherwise you will get dodgy results) E.g. builder_e is higher up in the list of jobs so it goes above builder_folder, which is underneath it in the list :)

views.View.reconfig()

Reconfigure the view with XML configuration or a builder.

Parameters:: xml (str or jenkins_pysdk.builders.Builder, optional) – The XML configuration of the view, defaults to None.
Returns:: Jenkins action object indicating the reconfiguration status.
Return type:: jenkins_pysdk.objects.JenkinsActionObject
Raises:: JenkinsGeneralException – If a general exception occurs.

from jenkins_pysdk.jenkins import Jenkins
jenkins = Jenkins(host="JenkinsDNS", username="admin", token="11e8e294cee85ee88b60d99328284d7608")
xml = """
   <hudson.model.ListView>
     <name>my_view</name>
     <description>Your view description</description>
     <filterExecutors>false</filterExecutors>
     <filterQueue>false</filterQueue>
     <properties class="hudson.model.View$PropertyList"/>
     <jobNames>
       <comparator class="hudson.util.CaseInsensitiveComparator"/>
       <string>builder_e</string>
       <string>builder_folder</string>
       <string>builder_w</string>
       <string>new_freestyle</string>
     </jobNames>
     <jobFilters/>
     <columns>
       <hudson.views.StatusColumn/>
       <hudson.views.WeatherColumn/>
       <hudson.views.JobColumn/>
     </columns>
     <recurse>true</recurse>
   </hudson.model.ListView>
  """
  print(jenkins.views.search("my_view").reconfig(xml))

The above code will output:

request=<Request object at 2153302882832> content='[200] Successfully reconfigured view (my_view).' status_code=200

Delete the view

views.View.delete()

Delete the view.

Returns:: Jenkins action object indicating the delete status.
Return type:: jenkins_pysdk.objects.JenkinsActionObject

from jenkins_pysdk.jenkins import Jenkins
jenkins = Jenkins(host="JenkinsDNS", username="admin", token="11e8e294cee85ee88b60d99328284d7608")
print(jenkins.views.search("YourViewName").delete())

The above code will output:

request=<Request object at 2246812676752> content='[200] Successfully deleted view (YourViewName).' status_code=200