Package org.jenkinsci.plugins.pubsub

Enum Class EventProps.Job

java.lang.Object

java.lang.Enum<EventProps.Job>

org.jenkinsci.plugins.pubsub.EventProps.Job

All Implemented Interfaces:

Serializable, Comparable<EventProps.Job>, Constable

Enclosing interface:

EventProps

public static enum EventProps.Job
extends Enum<EventProps.Job>

Pre-defined Job channel event property names.

• See Events.JobChannel for Job channel events.
• See EventProps.Jenkins for core properties common to most/all messages.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
job_ismultibranch	Job is a multi-branch job.
job_multibranch_indexing_result	Multi-branch job indexing result.
job_multibranch_indexing_status	Multi-branch job indexing status.
job_name	Job name.
job_run_commitId	Job run SCM commit Id, if relevant.
job_run_queueId	Job run Queue Id.
job_run_status	Job run status/result.

Method Summary

Modifier and Type	Method	Description
static EventProps.Job	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EventProps.Job[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

job_name

public static final EventProps.Job job_name

Job name.

job_ismultibranch

public static final EventProps.Job job_ismultibranch

Job is a multi-branch job.

"true" if it is a multi-branch job, otherwise it is not a multi-branch job.

job_multibranch_indexing_status

public static final EventProps.Job job_multibranch_indexing_status

Multi-branch job indexing status.

job_multibranch_indexing_result

public static final EventProps.Job job_multibranch_indexing_result

Multi-branch job indexing result.

job_run_queueId

public static final EventProps.Job job_run_queueId

Job run Queue Id.

This is how you correlate between Job Queue tasks and the Runs that result from them.

job_run_status

public static final EventProps.Job job_run_status

Job run status/result.

job_run_commitId

public static final EventProps.Job job_run_commitId

Job run SCM commit Id, if relevant.

Method Details

values

public static EventProps.Job[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static EventProps.Job valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null