com.offbytwo.jenkins.model

Class Job

java.lang.Object

com.offbytwo.jenkins.model.BaseModel

com.offbytwo.jenkins.model.Job

Direct Known Subclasses:

FolderJob, JobWithDetails, LabelWithDetails, MavenJob

public class Job
extends BaseModel

Field Summary

Fields inherited from class com.offbytwo.jenkins.model.BaseModel

client

Constructor Summary

Constructors

Constructor and Description
Job()
Job(String name, String url)
Job(String name, String url, String fullName)

Method Summary

Modifier and Type	Method and Description
QueueReference	build() Trigger a build without parameters
QueueReference	build(boolean crumbFlag) Trigger a build with crumbFlag.
QueueReference	build(Map<String,String> params) Trigger a parameterized build with string parameters only
QueueReference	build(Map<String,String> params, boolean crumbFlag) Trigger a parameterized build with string parameters only
QueueReference	build(Map<String,String> params, Map<String,File> fileParams) Trigger a parameterized build with file parameters
QueueReference	build(Map<String,String> params, Map<String,File> fileParams, boolean crumbFlag) Trigger a parameterized build with file parameters and crumbFlag
JobWithDetails	details()
boolean	equals(Object o)
String	getFileFromWorkspace(String fileName) Get a file from workspace.
String	getFullName()
String	getName()
String	getUrl()
int	hashCode()

Methods inherited from class com.offbytwo.jenkins.model.BaseModel

get_class, getClient, setClient

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Job

public Job()

Job

public Job(String name,
           String url)

Job

public Job(String name,
           String url,
           String fullName)

Method Detail

getName

public String getName()

getUrl

public String getUrl()

getFullName

public String getFullName()

details

public JobWithDetails details()
                       throws IOException

Throws:

IOException

getFileFromWorkspace

public String getFileFromWorkspace(String fileName)
                            throws IOException

Get a file from workspace.

Parameters:

fileName - The name of the file to download from workspace. You can also access files which are in sub folders of the workspace.

Returns:

The string which contains the content of the file.

Throws:

IOException - in case of an error.

build

public QueueReference build()
                     throws IOException

Trigger a build without parameters

Returns:

QueueReference for further analysis of the queued build.

Throws:

IOException - in case of an error.

build

public QueueReference build(boolean crumbFlag)
                     throws IOException

Trigger a build with crumbFlag.

Parameters:

crumbFlag - true or false.

Returns:

QueueReference for further analysis of the queued build.

Throws:

IOException - in case of an error.

build

public QueueReference build(Map<String,String> params)
                     throws IOException

Trigger a parameterized build with string parameters only

Parameters:

params - the job parameters

Returns:

QueueReference for further analysis of the queued build.

Throws:

IOException - in case of an error.

build

public QueueReference build(Map<String,String> params,
                            boolean crumbFlag)
                     throws IOException

Trigger a parameterized build with string parameters only

Parameters:

params - the job parameters

crumbFlag - true or false.

Returns:

QueueReference for further analysis of the queued build.

Throws:

IOException - in case of an error.

build

public QueueReference build(Map<String,String> params,
                            Map<String,File> fileParams)
                     throws IOException

Trigger a parameterized build with file parameters

Parameters:

params - the job parameters

fileParams - the job file parameters

Returns:

QueueReference for further analysis of the queued build.

Throws:

IOException - in case of an error.

build

public QueueReference build(Map<String,String> params,
                            Map<String,File> fileParams,
                            boolean crumbFlag)
                     throws IOException

Trigger a parameterized build with file parameters and crumbFlag

Parameters:

params - the job parameters

fileParams - the job file parameters

crumbFlag - determines whether crumb flag is used

Returns:

QueueReference for further analysis of the queued build.

Throws:

IOException - in case of an error.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object