PipelineAdmins (jenkins-library 1.4.0 API)

jenkins_shared_library.pipelines.base.PipelineAdmins

Stores the list of admins for a pipeline.

Example:

     def admins = new PipelineAdmins()
     // add some admins
     admins.add('adminA', 'admin-b', 'another-admin')
     // show "We have 3 admins."
     echo "We have ${admins.size()} admins."
     // show admin name
     echo "another-admin's name is ${admins.get('another-admin').name}."
     // get email list
     def emailTo = admins.getEmailList()
     // emailTo should be a string similar to:
     // "adminA@gmail.com,admin-b@hotmail.com,another-admin@ibm.com"

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`add(java.lang.String... admins)` Define admin users to the pipeline.
	`PipelineAdmin`	`get(java.lang.String id)` Get a particular admin from the User ID.
	`java.lang.String`	`getCCList()` Gets the admin emails as a CC list.
	`java.lang.String`	`getCommaSeparated()` Gets the admin User IDs as a comma separated list.
	`java.lang.String`	`getEmailList()` Gets the admin emails as a TO list.
	`int`	`getSize()` Gets the number of admins defined.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Method Detail
  - void add(java.lang.String... admins)
    
    Define admin users to the pipeline.
    throws:
    AdminInitializationException when encountering an error creating an admin user.
    
    Parameters:
    admins - A list of user ids to add to the pipeline.
  - PipelineAdmin get(java.lang.String id)
    
    Get a particular admin from the User ID.
    Parameters:
    id - The User ID to lookup
    Returns:
    An object representing the admin user or null if none was found.
  - java.lang.String getCCList()
    
    Gets the admin emails as a CC list.
    Returns:
    a CC list of admin emails.
  - java.lang.String getCommaSeparated()
    
    Gets the admin User IDs as a comma separated list.
    This list can be used in an input step
    
    Returns:
    Comma separate list of admin User IDs.
  - java.lang.String getEmailList()
    
    Gets the admin emails as a TO list.
    Returns:
    a TO list of admin emails.
  - int getSize()
    
    Gets the number of admins defined.
    Returns:
    The number of admins defined

Summary:
Method

| Detail:
Method

Groovy Documentation

[Groovy] Class PipelineAdmins

Methods Summary

Inherited Methods Summary

Method Detail

void add(java.lang.String... admins)

PipelineAdmin get(java.lang.String id)

java.lang.String getCCList()

java.lang.String getCommaSeparated()

java.lang.String getEmailList()

int getSize()